Chapter 17: Documenting (My web server) Your Software Project 339 Many
Chapter 17: Documenting Your Software Project 339 Many introductory sections also include acknowledgements and lists of those involved in the project. It helps to have this information readily available at the beginning of the document so that future readers can seek out you or another member of the team as questions arise. Organizing the meat of the document Following this introductory section is the actual documentation of lessons learned. You can take one of several approaches to writing this portion of the document from listing activities in chronological order to alphabetizing under topics. No matter which approach you take, we highly recommend that this material be divided into sections. One of the easiest divisions you can choose is to break the content down into lessons learned by various key stakeholders, with each group getting its own section. Prioritize the order of the groups based on who is most likely to need the information. For example: Lessons learned by developers (this should be the first section because developers have a higher chance of needing the information than others). Lessons learned by project managers (second in importance). Lessons learned by users (third in importance). Lessons learned for other participants. In every part, you list problems and solutions. You should be as specific as possible about the problems; problems have a tendency to follow patterns, so your specific description of a problem (and its coordinating solution) may mirror something a future reader is facing. The best thing you can do with a lessons learned document is give future readers an A-ha moment when they stumble across your text in the two-years-from-now time capsule and realize that you just helped them immensely. Organizing your references, contributors, and resources After the meat of the document, the lessons learned document should end with a section of references, resources, and contributors. The acknowledgements section at the beginning of the document tends to list everyone who worked on the project, while the contributors section often lists those who
We recommend cheap and reliable webhost to host and run your web applications: Coldfusion Web Hosting services.