06-23-2004, 11:21 PM
Guys, can you show me the guideline of writing a documentation?
Coz the documentation that i did, for all my previous projects seems to be abit of a "child's play".
Here's an example of the documentation i wrote for my last project.
Give me some reviews on the doc, how can i improve it? Or is it juz rubbish?
06-24-2004, 08:20 AM
Rubbish? I would say no. Any documentation is better than no documentation and if I were someone coming in to support your application, I would appreciate the effort.
Depending on the project though, there are many levels of documentation that should be a part of the project.
A few years of go, I was a part of a team (S.W.A.T or Software Architecture Team) whose purpose was develop a set of standards for software development projects for my current employeer. A couple of references that I brought to the table proved to be quite good and helping us develop a set of guidelines. One was very wordy, but the jist of it had relevant applications to our needs. The second was a book whose related web site had template documents that we were able to modify to our needs.
Check out book "Software Project Survival Guide" ISBN: 1-57231-621-7 and the documents at NASA's Software Engineering Lab Documentation List (http://sel.gsfc.nasa.gov/website/documents/online-doc.htm).
The specific document from the SEL that I was referring to above is SEL-81-305. Alot of the other documents provided support for that one