Samurai Programmer.com

"By three methods we may learn wisdom:  First, by reflection, which is noblest; Second by imitation,
which is easiest; and third by experience, which is the bitterest." - Confucius

Welcome to Samurai Programmer.com Sign in | Join | Help
in Search

Enterprise Documentation

Last post 06-04-2007, 1:25 PM by Dadio. 1 replies.
Sort Posts: Previous Next
  •  05-24-2007, 10:56 PM 53

    • Bill is not online. Last active: 2007-05-24, 10:55 PM Bill
    • Top 10 Contributor
    • Joined on 05-25-2007
    • Orange County, California
    • Posts 1

    Enterprise Documentation

    Documentation is one of the least sexy things about programming.  We know why we have to do it, but it is so much easier not to.  In many cases, the documentation that is prepared is ignored, destroyed, or simply lost.  Even using SourceForge for project management, the documentation is falls into two categories: Ignored and Not Created.

    My question for consideration is:

    How do you get your coworkers to pay attention to documentation without beating them over the head with it?

    (I know that method works -- waiting for the statute of limitations to run out gave me an excuse not visit another state...)




    Cheers!
  •  06-04-2007, 1:25 PM 58 in reply to 53

    Re: Enterprise Documentation

    No one likes to create documentation because they know as soon as its written its outdated and typically no one reads it. So why waste the time.  I alwyas liked to write the documentation first for projects and get sign-off then do the code. This way the documentation governs the development decision process. Minor updates to the documentation can be made while development is progressing.

    When the documentation is done first it can feed the development, qc/qa, training, marketing, sales, etc processes.

View as RSS news feed in XML
Powered by Community Server, by Telligent Systems