Documentation Pages

From FOSSWiki

Documentation: a detailed and systematic account of all development processes to include

- Active Developers names and contacts

- requirements analysis and specification (functional and systems requierments)

- system/module design and pseudocode

- annotated code of each function indicating how the code addresses the equirements

- tests carried out

- modification from original design plan

- TBD (to be done) things that need to be improved/changed/added in each function

Given the modular nature of the software, it is advisable that project documentation is specifically global (pertains the whole system) or local (pertains only to a module). This information should help to align different activities being carried out by different developers.

1. System Functionality (define functional requirements) Here we should list use case, scenarios, and personas of any given possible instance of usage of the system. This would include platform, environment and communication protocols for the system in general.

Here we should try to answer the quetions like: How will the system integrate with other systems?

2. Modules Functionality (define use case, scenarios, and personas of any given possible instance of usage of each module. This would include platform, environment and communication protocols for the system in general.

Here we should try to answer questions like: how will the module integrate with other systems?