Images in this post missing? We recently lost them in a site migration. We're working to restore these as you read this. Should you need an image in an emergency, please contact us at imagehelp@codebetter.com
Maintainable by whom

Let's say you are hired to help build or fix an application. You contract is not for hire and you know that after 3, 6 or 12 months you will be gone to repeat the same cycle elsewhere.

I'm sure we have all seen contractors that will do just about anything to complete the task in the allotted time span, sometimes in detriment of the code quality and maintainability. I'm also sure that if you're reading this then you probably care about this enough to avoid replicating this pattern.

But here are some important things that might go unnoticed in the above paragraph.

  • Define The Task
  • Define Quality
  • Define Maintainability

The Task

In my limited experience, I'd say it would be shocking to be hired to just write code regardless of any parameters, as long as the deadline is met. I don't expect to hear from my client "I don't care if what you write is absolute garbage material but it needs to go live in 6 months."

Even if the client is very much driven by the deadline, even if the client doesn't say it out loud, there will always be an implicit expectation that our solution will have a minimum of quality to survive the planned life time.

Our task is never to just write code. They could have hired a high school intern if that's all they wanted.

Quality

I think the quality of a software product is directly related to how well the product adheres to the specifications. Oh, no, specifications. One more thing to consider.

If we're lucky the specifications will be available and include not only the product feature list but also architectural needs, expected maintenance and upgrade pains.

Again, we are not being given carte blanche, even if it sounds like we are. Maybe the client doesn't know how to communicate that to us, but we ought to know that our design needs to accommodate changes and lay on top of a maintainable platform.

Maintainability

The ease with which a software system or component can be modified to correct faults, improve performance, or other attributes, or adapt to a changed environment - IEEE Standard Computer Dictionary

The IEEE definition above is fine but, after a discussion in the last Chicago ALT.NET meeting, there seems to be an important omission here and the main reason for this post.

Maintainable by whom?

The same way our proverbial consultant from the beginning of the post could deliver abominably graded solutions and run away, so can we — with all our shiny, fancy-pants design and tools.

We have the responsibility of designing a solution that is maintainable by the client with their staff of with realistic chances of finding other contractors that can take it on (not necessarily us all the time.)

We have to weight our design decisions and desire to apply the better tools and architecture against the existing scenario. When discussing the possible solutions with the rest of the team that's a good opportunity to assess what kind of team we have to work with (or work for.) If the scenario doesn't look good, there at least two things that can be done:

  1. Discuss the problem with the client and suggest that the staff would benefit from some training or mentoring, so that we can apply a solution that can be maintained more effectively. Training and mentoring may be strong words, sometimes a few informal sessions with the team can go a long way.
  2. If the above is not possible, then the responsible thing to do is choosing a design that the existing team will be comfortable maintaining after our departure. Knowing when to suppress your good intentions is also an important quality of a good consultant, I think.

That's not to say that we should give up trying to raise maintainability bar of our application designs. The rising tide can lift most boats but careful with the over-dimensioned anchors.


Posted 06-17-2008 11:34 AM by sergiopereira
Filed under:

[Advertisement]

Comments

Yann Trevin wrote re: Maintainable by whom
on 06-17-2008 2:40 PM

Very pertinent. This is indeed a critical issue which is most of time totally ignored by the customer... and sometimes by the development team as well, which is probably worst. They focus only on the conception and the development phases; and optimistically (!) believe that once completed, the system will work fine forever without any maintenance.

Off topic: it would be nice to provide a link to your source when you make citations (like for the IEEE definition) No offense. Just a remark.

sergiopereira wrote re: Maintainable by whom
on 06-17-2008 3:40 PM

@Yann, I would add the proper link but there isn't one because the content is paid. If you wish to buy the PDF, the link is: http://ieeexplore.ieee.org/xpl/freeabs_all.jsp?tp=&isnumber=4148&arnumber=159342&punumber=2238

Remarks are welcome.

Reflective Perspective - Chris Alcock » The Morning Brew #117 wrote Reflective Perspective - Chris Alcock » The Morning Brew #117
on 06-18-2008 2:07 AM

Pingback from  Reflective Perspective - Chris Alcock  » The Morning Brew #117

Kyle Baley wrote re: Maintainable by whom
on 06-18-2008 9:13 AM

I love discussing this topic because the right answer is different from client to client. It's a balancing act 'twixt training and coding and existing skill level and team's willingness to learn and lifespan of the project.

sergiopereira wrote re: Maintainable by whom
on 06-18-2008 9:27 AM

@Kyle, agreed. One bad outcome can be that you may leave the client feeling that you could have accomplished more but there was no interest in hearing "all your crazy design principles talk." Oh, the rejection.

Arjan`s World » LINKBLOG for June 18, 2008 wrote Arjan`s World » LINKBLOG for June 18, 2008
on 06-18-2008 10:40 AM

Pingback from  Arjan`s World    » LINKBLOG for June 18, 2008

jdn wrote re: Maintainable by whom
on 06-24-2008 8:18 PM

Ah, come on.  You could have at least linked to Ayende and my (among others) discussion about this:

www.blogcoward.com/.../29.aspx

www.ayende.com/.../Maintainable-but-for-whom.aspx

jdn

sergiopereira wrote re: Maintainable by whom
on 06-24-2008 10:52 PM

I did not know you or Ayende had posts on the subject. To be fair Ayende probably has a post about anything you can think of, so consider him linked every time you write more than 3 words in a blog post.

About The CodeBetter.Com Blog Network
CodeBetter.Com FAQ

Our Mission

Advertisers should contact Brendan

Subscribe
Google Reader or Homepage

del.icio.us CodeBetter.com Latest Items
Add to My Yahoo!
Subscribe with Bloglines
Subscribe in NewsGator Online
Subscribe with myFeedster
Add to My AOL
Furl CodeBetter.com Latest Items
Subscribe in Rojo

Member Projects
DimeCasts.Net - Derik Whittaker

Friends of Devlicio.us
Red-Gate Tools For SQL and .NET

NDepend

SlickEdit
 
SmartInspect .NET Logging
NGEDIT: ViEmu and Codekana
LiteAccounting.Com
DevExpress
Fixx
NHibernate Profiler
Unfuddle
Balsamiq Mockups
Scrumy
JetBrains - ReSharper
Umbraco
NServiceBus
RavenDb
Web Sequence Diagrams
Ducksboard<-- NEW Friend!

 



Site Copyright © 2007 CodeBetter.Com
Content Copyright Individual Bloggers

 

Community Server (Commercial Edition)