Link Details

Link 52535 thumbnail
User 217101 avatar

By gst
Published: Nov 12 2007 / 17:20

This will stay between you and me I promise : How many of you take the time to write complete and meaningful documentation for your applications? It seems to always be the last thing we want to work on or think about. There are many reasons for that, but the most obvious is because documentation is not mandatory for your application to work… so it’s easy to “forget”. It’s way more exciting to code new features, improve the design, refactor some old code, drink Buckley’s syrup, roll discretely on the floor pretending you are Rambo 2 and so on than it is to document your application. But the fact doesn’t change : Having good documentation for your application is important. Without a good tool to help you create documentation that is dynamic, structured, easily editable, consistent and visually pleasing, it will take you forever because you will have to do it by hand. And even if you’re crazy enough to do that, it will have taken so much of your time that just thinking about doing it again for your next project will make your nose bleed… and ultimately you will start to regret the day you choose to become a developer.
  • 12
  • 0
  • 2456
  • 2


Add your comment
User 236137 avatar

dzonelurker replied ago:

0 votes Vote down Vote up Reply

I guess, documentation isn't Agile. Programmers nowadays write Unit Tests to document their code, a.k.a. TDD. Unclear points are discussed in the daily stand-up meeting at 10.

Add your comment

Html tags not supported. Reply is editable for 5 minutes. Use [code lang="java|ruby|sql|css|xml"][/code] to post code snippets.

Voters For This Link (12)

Voters Against This Link (0)

    Java Performance Optimization
    Written by: Pierre-Hugues Charbonneau
    Featured Refcardz: Top Refcardz:
    1. Design Patterns
    2. OO JS
    3. Cont. Delivery
    4. Java EE7
    5. HTML5 Mobile
    1. Node.js
    2. Debugging JavaScript
    3. OO JS
    4. JSON
    5. Ajax