Programming Project Documentation
Technical documentation is often required for programming projects within the workplace. Providing this documentation makes implementing the program easier and supplies others with information related to the functionality of the program.
For this assignment, you will submit programming project documentation that others can use as a primary source. The documentation should include the following.
1. Title Page:
a. course code and name
b. student name
c. instructor name
d. project title
e. date of submission
2. Introduction:
a. Define the problem and provides an overview of the solution.
b. Critical terminology and definitions that will appear frequently in other sections of the document can also be introduced in this section.
3. Program Interface:
a. Explain how users communicate with the program
i. Setting up the programming environment
ii. Commands that execute the program
iii. Command parameters
iv. Program termination
4. Program Execution:
a. Explain how end-users execute the program
i. Describe algorithms, data structures, and implementation
ii. Program inputs supplied by the user
iii. Program outputs
iv. Program functionality
v. Program menu options
vi. Program parts
b. Include screen outputs and figures
c. Divide content into subsections
5. Input and Output:
a. Explain input and output including exact formal of files
b. Include examples of input and outputs along with explanations
6. Program Structure:
a. Technical guide for understanding the program
b. Use subsections to document the following:
i. Provide overall program structure and explanation of subprogram, modules, classes, etc.
ii. Include explanation of data structures including types, variables, domains, etc.
7. Examples:
a. Provide examples that show how different inputs effect the behavior of the program
8. Improvements and Extensions:
a. Evaluate the strengths and weaknesses of the program
b. Discuss areas where the project could be improved in future iterations
c. Include discussion of how the project plan changed throughout the development process and explanation of why these changes occurred
9. Difficulties Encountered:
a. Summarize the difficulties that emerged during project construction
b. Explain the effects of the difficulties on the project
10. Conclusion:
a. Write conclusions about the project
11. References:
a. Document research references that were used to develop the program
i. Document research references in APA format
12. Appendices:
a. Program source code files
b. Execution details and complex sample executions (optional)
