This page contains the details of a technical writing project accepted for Google Season of Docs.
Project summary
- Open source organization:
- moja global
- Technical writer:
- Anthony
- Project name:
- Documentation of Reporting Tool Code
- Project length:
- Standard length (3 months)
Project description
Given the opportunity to document the Reporting Tool for the Moja Global organization, I propose to develop 6 types of documentation that will be utilized by different audiences to achieve different purposes. These are as summarised below:
1)Environment Setup Guide
1.1) Target Audience System Engineers
1.2) Objective Help System Engineers set up a local build and execution environment for the Reporting Tool.
1.3) Format A How-to Article that prescribes the set of sequential steps that System Engineers must take to set up the environment that will be conducive for the building and running of the Reporting Tool.
2)Build Guide
2.1) Target Audience System Engineers
2.2) Objective Help System Engineers build the Reporting Tool components from the source code
2.3) Format A How-to Article that prescribes the set of sequential steps that System Engineers must take to obtain and compile Reporting Tool’s Source Code.
3)Installation Guide
3.1) Target Audience System Engineers
3.2) Objective Help System Engineers install freshly built Reporting Tool components
3.3) Format A How-to Article that prescribes the set of sequential steps that System Engineers must take to deploy the Reporting Tool on a freshly setup environment.
4)Operation Guide
4.1) Target Audience System Integrators
4.2) Objective Help System Engineers run a freshly installed Reporting Tool instance
4.3) Format A How-to Article that prescribes the set of sequential steps that System Integrators must take to upload and process Flux Output Databases on a running Reporting Tool instance.
Operation Guide Onboard and process Flux Output Databases in the Reporting Tool
5)User Guide
5.1) Target Audience End Users
5.2) Objective Help End Users understand the different features embedded in the Reporting Tool and how these features should be used.
5.3) Format A How-to Article that prescribes the set of sequential steps that End Users must take to properly utilise the Reporting Tool’s Functionalities.
6) Development Guide
6.1) Target Audience Programmers
6.2) Objective Help End Users understand the different features embedded in the Reporting Tool and how these features should be used.
6.3) Format Reference Articles that describe: a)the major design elements that make up the tool b)the functional decomposition of the above elements c)the execution elements of the functionally decomposed elements d)the tool’s source code / libraries organization e)the long term vision and direction for continuous improvement f)the logical next areas for improvement
And a short tutorial that describes how the code can be adjusted to user specific circumstances