Documentation Standard - Thoolium/holoBender GitHub Wiki

This is a document to outline the way in which the team will document the development process for this project

Author: Stephanie Batten

How We Will Document:

Documentation will be completed using the GitHub wiki page. Documentation will be organised by feature and in chronological order. ie the base level program shall be documented first and in chronological order and then each subsequent feature will be documented in chronological order. Naming of pages should follow this naming convention: "Program"/"Feature" : "Development"/"Code"/"Research" - [up to 4 key words]. For example if I am determining what coordinate system to use I may call the page "Program: Research - Choosing a Coordinate System". Or if I am developing the program shell I may call the page "Program: Development - creating a program shell" and I may include a second page to give code examples called "Program: Code - creating a program shell".

Once the page is completed it should be added to the sidebar in the appropriate location based on the feature and chronological order.

What We Will Document:

We shall treat this documentation process as a methods section. Therefore anything we expect to include in the methods section of the report should be documented here in detail. We will summarise it for the report. We should also include enough detail on how we developed the program that if we were to pass it on to another project team next year they could continue development with no prior knowledge of our code.

Some examples of what we may include: Development of the shell - we may include information on which parts of the shell can be edited to add new features. Production of markers - we may include information about how we produced markers and how we integrated them into the system so that it is possible for a new team to include their own new markers.