Geeks With Blogs

Connected Systems Chilled Out Blog Hanging stuff together in a meaningful way with some fun added

Over the years I think I have heard every excuse going for not producing design documentation. Here is a short list:

  • Delivery is required now so the sooner I begin coding, the better.
  • Its more agile to not write docs 
  • The document will quickly drift out of synch with the code very quickly 
  • We can always produce it later, if we have to.
  • Hey who looks at design documents anyway
  • Its in the the code comments anyway 
  • I’m paid to write software, not technical documents
  • The customer wants working software, not documents
  • No one made me do it on my previous projects
  • Everyone on the team knows how the system is designed, thats all the matters 
  • A good design will emerge once we begin coding we don't need to waste time now
  • It's on the white board 
  • I comment the source code thoroughly - its as good as a ny docs you'll produce
  • You can’t really understand how the software will work until you write the code
  • But what all this meant really was :

    'I hate writing documentation'

    So are there any real arguments...I'll cover this in part 2!

    Posted on Wednesday, May 26, 2004 4:12 PM | Back to top

    Comments on this post: The need for design documentation (Part 1)

    # re: The need for design documentation (Part 1)
    Requesting Gravatar...
    I tend to create a rough draft design document that's more diagram heavy than text heavy. It's enough to give fellow developers and testers enough information concerning my particular component. Once the coding is near complete or at least a lull is detected, I produce a more formal document.

    But yeah, I tend to agree that not creating a design document usually means that someone just doesn't like doing it.
    Left by Mark Schmidt on May 26, 2004 5:28 AM

    Your comment:
     (will show your gravatar)

    Copyright © BizTalk Visionary | Powered by: