In this assignment we will be completing documentation necessary to start coding the project. The objective of the developer documentation is that you could give your documentation and code to any competent developer and they would be able to create and work on the project.
Documentation Sections
Here are some items you should have in your documentation.
- Overview of project stating the purpose, audience, platform, and any other items that would describe what the software you are creating does.
- Programming stack and environment which should also include the current locations of the development, test, and production environments of the project. The stack documentation should give all levels of the stack with versions and links to documentation for that version.
- Coding conventions that are being followed in our project development. You can use an existing documented convention, use links to the convention you are using and take steps to enforce using that coding convention. See https://en.wikipedia.org/wiki/Coding_conventions
- If you want some help in how to set coding styles and standards this should help https://medium.freecodecamp.org/the-100-correct-coding-style-guide-5b594a1655f0
- An overview document that includes the locations of each of the separate documents that make up your documentation. If possible this document should contain hot links to those documents. This document will have the following required links (it can contain more) and you can have multiple items in one document
- Purpose and Overview
- Language and Coding
- Interface design specifications
- Code modules and object overview
- Platform and hosting information
Submission
You will be submitting a link to your Overview Document – I will check the other documents from there.
Example
An example of code documentation (one part of the final documentation) from a previous project can be found at – https://drive.google.com/open?id=1NIu1zp4UevS3Vhro5tS08gIFVqmm1lwwbXQhvu_b78c
Resources – Documentation on Github
Google Drive – You have multiple choices on where to document your project. If you choose to use Google Drive you simple need to set up the directory and place the documents in the Drive. You will need to create permissions for me to access and view your documentation.
Github – Another option that is popular is to use Github as your documentation repository. Github includes the Readme file and also every repository have a created wiki where you can include documentation and also work collaboratively with a team. Information on how to do this is at https://guides.github.com/features/wikis/