Docs Guide

[Rabby Lavilles]

Documentation Outline

 

1. Table of Contents

2. Executive Summary

A summary of all the essential information in the proposal so a busy executive can read it quickly and decide what parts of the plan to read in more depth.

3. System Request/ Description of the Current System/process

Describe the problem, current situation why do we need to create the system. You may use activity diagram to explain the current process.

4. Conceptual Model

Write a description of your solution to the problem. Define the new process based on the proposed solution.

5. Work plan

The original work plan, revised after having completed the analysis phase. It usually contains the Gantt Chart.

 

6. Requirements Definition

A list of the functional and nonfunctional business requirements for the system. List all functions and what the customer want. Summarize the information you gathered from the interview.

An activity diagram and a set of use cases that illustrate the basic processes that the system needs to support.

9. Analysis and Design

A set of structural models for the to-be system. This may include structural models of the current as-is system that will be replaced. This may include activity diagram of the new process. Use case description and sequence diagram.

10. Data models

            This may include ERD and class diagram

11. The System

            Describe the system functionalities or features. This may include a screenshots of the system.

12. Implementation Issues

            Describe what programming languages used as well as problems encountered. Include Deployment diagram here. Requirement specification for hardware and software (user part)

13. Summary and Conclusion

14. Recommendations

Appendices

These contain additional material relevant to the proposal, often used to support the recommended system. This might include results of a questionnaire survey or interviews, industry reports and statistics, and so on.