Nadace pro otevřenou projektovou dokumentaci - Foundation for Open Project Documentation

The Nadace pro otevřenou projektovou dokumentaci [1]je organizace. Jeho hlavní myšlenkou je vytvořit podrobnou a veřejnou dokumentaci pro všechny fáze tvorby softwaru. Nadace byla založena v roce 2002 při slavnostním zahájení semifinále ACM International Collegiate Programming Contest v Petrohrad podle Anatoly Shalyto. Tato nadace byla vyhlášena na Linux Summit 2004,[2][3] Ruský summit o outsourcingu a softwaru 2004[4] a Open Source Forum Rusko 2005.[5] Schválení vypracování projektové dokumentace v rámci této nadace bylo provedeno v projektech vytvořených pomocí Přepínací technologie, určené k podpoře Programování na základě automatů.[6][7]

Anatoly Shalyto na Linux Summit 2004, Helsinky

Motivace

Motivace k tvorbě detailní dokumentace se považuje za následující:

  • zvyšuje se kvalita softwaru
  • zjednodušení ověření programu
  • modifikace projektu se stává snazší a bezpečnější

Motivace pro vytváření dokumentace otevřeno se považuje za následující:

  • projekt se stává méně závislým na původních autorech
  • ostatní lidé mohou snadno pochopit strukturu a chování programu
  • opětovné použití návrhových rozhodnutí je snazší a bezpečnější
  • je možné použít skutečný projekt pro studijní účely

aplikace

Nadace pro otevřenou dokumentaci projektu dává projektu větší potenciál srozumitelnosti a opětovné použitelnosti než Open Source Foundation. Je volně spojen s Free Software Foundation. Projekt OpenDoc může být také komerční.

Hlavní principy

  • Projektová dokumentace by měla být základem pro zdrojový kód, ale ne naopak.
  • Dokumentace by měla popisovat nejen konečný produkt, ale také proces jeho vytvoření.
  • Dokumentace by měla být snadno srozumitelná i pro méně kvalifikované vývojáře než její autor.
  • Dokumentace by měla být k dispozici pokaždé, když někdo prozkoumá nebo upraví projekt.

Reference

  1. ^ Shalyto A.Foundation for Open Project Documentation at Code Project Archivováno 2006-06-19 na Wayback Machine
  2. ^ Součást programu Linux Summit 2004
  3. ^ Shalyto A. Naumov L. Foundation for Open Project Documentation. Prezentace pro Linux Summit 2004
  4. ^ Čtvrtý ruský summit o outsourcingu a softwaru
  5. ^ Fotografie z fóra Open Source Rissua 2005
  6. ^ Projekty vytvořené pomocí technologie Switch s otevřenou projektovou dokumentací.
  7. ^ Projekty vytvořené pomocí nástroje UniMod s otevřenou projektovou dokumentací.

externí odkazy