Project Documentation Guideline
Acknowledgement
References
Main modules are:
- Introduction (Abstract For Terms Of Reference)
- Project Introduction
- Project Background or History
- Problem statement
- Feasibility Study
- Economic
- Technical
- Social
- System analysis (Abstract for RS document)
- Research of current Procedures and techniques
- Investigation
- Fact Finding
- Observation
- Reading Documents
- Asking staff
- Questionnaires
- Interviews
- Drawback/weaknesses of current Techniques
- Possible Solutions (All the possible solutions even manual if any)
- Proposed Solutions
- Specific objectives of my solution
- Constraints
- Timescale Or Timelines
- System Design (Abstract For FS Functional Specification )
- Hardware/ software Options (Hardware and Software needs)
- Proposed Hardware/ software solution (Tools used and there WHY factor)
- Cost and benefit analysis (for the above)
- System Design and Flow Diagrams (System flow, DFD’s, UML (proposed)) also involves the task, devices, media, files etc.
- System Architecture (Tiers involved)
- System inputs & file Layouts( DB design if any, can be in the next topic)
- System outputs (how system will correspond with user)
- User interfaces(not their design) and their flow
- System development
- Tables structure and design
- ER Diagram
- Dialogs design
- Testing and Evaluation(QA)
- Testing strategy (Logical, functional, System) (If any)
- Test Plan (Picture, presence, Range, Character count)
- Test Results (Error Dialogs)
- System Evaluation( Goals Achieved)
- Implementation and Maintenance
- Scope for future Development
- Version history
- User Manual
- System introduction
- Application System Installation
- How to begin
For Research Oriented project, the modules are:
Acknowledgement
References
- Introduction
- Project Introduction
- Project Background or History
- Problem statement
- System analysis (Abstract for RS document)
- Research of current Procedures and techniques
- Drawback/weaknesses of current Techniques
- Possible Solutions (All the possible solutions even manual if any)
- Proposed Solutions
- Specific objectives of my solution
- Constraints
- Timescale Or Timelines(project scheduling)
- System Design (Abstract For FS Functional Specification )
- Hardware/ software Options (Hardware and Software needs)
- Proposed Hardware/ software solution (Tools used and there WHY factor)
- Cost and benefit analysis (for the above)
- System Design and Flow Diagrams (System flow, DFD’s, UML (proposed)) also involves the task, devices, media, files etc.
- System inputs (Optional)
- System outputs (how system will correspond with user)
- User interfaces(not their design) and their flow
- System development
- Tables structure and design( If any)
- ER Diagram
- Forms and Dialogs design
- Testing and Evaluation(QA) and maintenance
- Testing strategy (Logical, functional, System) (If any)
- Test Results ( Including Error Dialogs)
- System Evaluation( Goals Achieved)
- Scope for future Development
- Version history
- User Manual
- System introduction
- Application System Installation
- How to begin
Comments