Foundation for Open Project Documentation
From Wikipedia, the free encyclopedia
Foundation for Open Project Documentation is a trend in computer software development. Its main idea is to create detailed and public documentation for all stages of software creation. The foundation was established in 2002 on the grand opening of the semifinals of ACM International Collegiate Programming Contest in Saint Petersburg by Anatoly Shalyto. Project documentation development approbation in the context of this foundation was made in projects created using Switch-technology, intended for supporting Automata-Based Programming.
Contents |
[edit] Motivation
The motivation for creating detailed documentation is considered the following:
- software quality increases
- program verification simplifies
- project modification becomes easier and safer
The motivation for making documentation open is considered the following:
- project becomes less dependent on its initial authors
- other people can easily understand structure and behaviour of a program
- design decisions reuse becomes easier and safer
- it becomes possible to use real project for study purposes
[edit] Application
Foundation for Open Project Documentation gives a project a greater uderstandability and reusability potential, than Open Source foundation. It is loosely connected with Free Software Foundation. OpenDoc project can also be commercial.
[edit] Main principles
- The project documentation should be a base for source code, but not vice versa.
- The documentation should describe not only the final product, but also the creation process.
- The documentation should be easy to understand even for less qualified developers than its author.
- The documentation should be available every time anyone explores or modifies a project.
