Documenting
Download as PPT, PDF0 likes290 views
The document discusses the importance of documentation at each stage of the software development process (SDP), including analysis, design, implementation, testing, documentation, and maintenance. Effective documentation provides the basis for subsequent stages, describes elements like software specifications, design descriptions, code explanations, test plans, and logs changes made to systems over time. Proper documentation ensures software is developed according to client specifications and informs others about a system's components and any changes made.
Documenting
- 1. Documentation Why we need documentation At each stage of ADITDEM
- 2. Documenting Analysis Software Specification Forms the basis of the remaining stage of the SDP
- 3. Documenting Design Description of design in appropriate design notation Bridge between code and software spec
- 4. Documenting Implementation Program listing, the program comments. Explains each part of the code
- 5. Documenting Testing The plan of attack on the test. The test plan. Indicates whether program is doing what it should do
- 6. Documenting Documentation The technical guide and the user guide are produced You didn’t forget these two did you?
- 7. Documenting Evaluation Acceptance test report. Shows that product has been written to the specification of the client
- 8. Documenting Maintenance Log of changes made to the system Informs people (programmers) about changes already made