DOCUMENTATION Flashcards
Documentation
Collects information about the system usually in written format.
System Documentation
Describe system itself.
Written so that software can be maintained and modified by people other than the original developer.
User Documentation
As user guide/manual.
Step by step instructions on how to use system.
Can contain tutorials and screenshot.
Powerful marketing tool.
Written for both novice and expert users.
Technical Documentation
Helps clients’ processes regarding installation and gets unstruck.
Understand inner,outer dependencies of software.
Why Documentation important?
More knowledge about the system.
Describe how users should operate and administer system.
Future references & use.
Traceability purposes.
Describe a range of documentation that should be given to you by the Project Manager
prior to development
Functional Requirements Document
Technical Requirements Document
Architecture Document
Design Document
Testing Plan
List the documentation that each programmer should produce on completion of their
programming task
Code documentation
User manual
Test documentation
Maintenance documentation
Documentations to know
Code documentation
User manual
Maintenance documents
Functional Requirements documents
Architecture documents
Design documents
Testing planning
Technical documents
Testing requirements documents