Foundation for Open Project Documentation

Foundation for Open Project Documentation

The Foundation for Open Project Documentation [Shalyto A. [http://www.codeproject.com/gen/design/nifopd.asp Foundation for Open Project Documentation at Code Project] ] is an organization. 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. This foundation was announced on the Linux Summit 2004 [ [http://is.ifmo.ru/foundation/linux/ Part of the program of Linux Summit 2004] ] [Shalyto A. Naumov L. Foundation for Open Project Documentation. [http://is.ifmo.ru/foundation_en/_Presentation.en.ppt Presentation for Linux Summit 2004] ] , Russian Outsourcing and Software Summit 2004 [ [http://www.soft-outsourcing.com/upload/ross2004.pdf Fourth Russian Outsourcing and Software Summit] ] and Open Source Forum Russia 2005 [ [http://is.ifmo.ru/science/opensource/ Photos from Open Source Forum Rissua 2005] ] . Project documentation development approbation in the context of this foundation was made in projects created using Switch-technology, intended for supporting Automata-Based Programming [ [http://is.ifmo.ru/projects_en/ Projects, created using Switch technology with open project documentation.] ] [ [http://is.ifmo.ru/unimod-projects-en/ Projects, created using UniMod tool with open project documentation.] ] .

[
Anatoly Shalyto on Linux Summit 2004, Helsinki ]

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

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.

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.

References

External links

* [http://is.ifmo.ru/foundation_en Foundation for Open Project Documentation at Programming Technologies Department of SPbSU ITMO website]
* [http://is.ifmo.ru/foundation_en OpenDoc projects at Programming Technologies Department of SPbSU ITMO website]


Wikimedia Foundation. 2010.

Игры ⚽ Нужна курсовая?

Look at other dictionaries:

  • Open source software development — is the process by which open source software (or similar software whose source code is publicly available) is developed. These are software products “available with its source code and under an open source license to study, change, and improve… …   Wikipedia

  • Open Directory Project — URL dmoz.org Commercial? No Type of site Web directory …   Wikipedia

  • Open source software — (OSS) began as a marketing campaign for free software [cite web archiveurl=http://web.archive.org/web/20060423094434/www.opensource.org/advocacy/faq.html title=Frequently Asked Questions |publisher=Open Source Initiative archivedate=2006 04 23… …   Wikipedia

  • Open content — or OpenContent is a neologism coined by David Wiley in 1998[1] which describes a creative work that others can copy or modify. The term evokes open source, which is a related concept in software.[2] When the term OpenContent was first used by… …   Wikipedia

  • Open gaming — is the movement within the role playing game (RPG) industry that is somewhat similar to the open source movement.[1] The key aspect is that authors give recipients of works covered by copyright a license to certain rights, such as the right to… …   Wikipedia

  • Open Graphics Project — Website http://wiki.opengraphics.org/tiki index.php Commercial? Yes Type of project Open hardware …   Wikipedia

  • Open Wonderland — Original author(s) Open Wonderland Foundation, Sun Microsystems Preview release 0.5 User Preview 4 (2010 0 5 A4) / May 2010; 16 months ago (2010 05) …   Wikipedia

  • Open University — is also the name of other institutions. See Distance education or the Open Universities category for a list. The Open University Motto Learn and Live Established …   Wikipedia

  • Project Blue Book — was one of a series of systematic studies of Unidentified flying objects (UFOs) conducted by the United States Air Force (U.S.A.F.). Started in 1952, it was the second revival of such a study. A termination order was given for the study in… …   Wikipedia

  • Open-source software — The logo of the Open Source Initiative Open source software (OSS) is computer software that is available in source code form: the source code and certain other rights normally reserved for copyright holders are provided under a software license… …   Wikipedia

Share the article and excerpts

Direct link
… Do a right-click on the link above
and select “Copy Link”