dokumentacja aplikacji, jak powinna wygladac? Opcje

[AxZx]

witam

mam przygotowac dokumentacje juz gotowej aplikacji, ale nie wiem za bardzo jak taki dokument powinien wygladac.
czy mozna gdzies znalezc przykladowy konspekt?

chcialbym to w celu edukacyjnym, nie zarobkowym.
pozdrawiam

[AxZx]

i tylko tyle?
mi nie chodzi o udokumentowanie kodu tak jak to zrobi phpdoc, albo tak jak to robia tworcy frameworkow. moze jest to podobne do tego co daje sie klientowi ale chyba nie dokonca.
framework to jest tylko framework wiec nie bedzie tam opisu funkcjonalnosci dla poszczegolnych uzytkownikow itd.
poszukuje raczej poprawnego konspektu do dokumnetacji dla odbiorcy koncowego danej aplikacji - co ma sie tam znalezc, jaka struktura takiego dokumentu itp.

[empathon]

i tylko tyle?
mi nie chodzi o udokumentowanie kodu tak jak to zrobi phpdoc, albo tak jak to robia tworcy frameworkow. moze jest to podobne do tego co daje sie klientowi ale chyba nie dokonca.
framework to jest tylko framework wiec nie bedzie tam opisu funkcjonalnosci dla poszczegolnych uzytkownikow itd.
poszukuje raczej poprawnego konspektu do dokumnetacji dla odbiorcy koncowego danej aplikacji - co ma sie tam znalezc, jaka struktura takiego dokumentu itp.

Taką dokumentacje nazywamy dokumentacją użytkową. To o czym pisze kicaj i sniezny_wilk to dokumentacja techniczna.
Cytuję za "Inżynieria oprogramowania" Andrzej Jaszkiewicz:

Dokumentacja użytkowa jest przeznaczona dla różnych klas odbiorców. Dwie podstawowe klasy to:

• użytkownicy końcowi
• administratorzy systemu

[...]
Podstawowe składowe dokumentacji użytkowej to:

• Opis funkcjonalny. Jest to wstępna część dokumentacji, która w zwarty sposób opisuje przeznaczenie i głowne możliwości systemu. Opis funkcjonalny powinien dostarczać osobie rozważającej zakup lub wykorzystanie systemu niezbędnych informacji pozwalających ocenić czy system spełnia jej potrzeby. Opis funkcjonalny jest też przydatny początkującym użytkownikom, którzy nie znają jeszcze dobrze możliwości systemu.
• Podręcznik użytkownika. Jest to opis systemu przeznaczony głównie dla początkujących użytkowników. Część ta powinna zawierać informacje o:
  • sposobach uruchamiania oraz kończenia pracy z systemem
  • sposobach realizacji najczęściej wykorzystywanych funkcji systemu
  • metodach obsługi błędów, np. o sposobach odwoływania błędnych operacji wykonywanych przez użytkownika
  • sposobach korzystania z systemu pomocy
  Podręcznik użytkownika powinien przedstawić prosty przykład korzystania z systemu.
• Kompletny opis Jest to część przeznaczona głownie dla doświadczonych użytkowników. Powinna zawierać
  • szczegółowy opis wszystkich funkcji systemu
  • informacje o wszystkich sposobach wywoływania tych funkcji
  • opis formatów danych
  • opis błędów, które mogą się pojawić podczas pracy z systemem
  • informacje o wszelkich ograniczeniach dotyczących np. zakresów danych
• Opis instalacji. Jest to składowa dokumentacji przeznaczona gównie dla administratorów systemu. Powinna zawierać opis procedury instalacji oraz dostrojenia systemu do środowiska, w którym będzie pracować.
• Podręcznik administratora systemu. Część ta powinna opisywać możliwości zmian konfiguracji systemu i sposoby udostępniania systemu użytkownikom końcowym.

[...]
Zarówno całość dokumentacji, jak i poszczególne podręczniki mogą dodatkowo zawierać:

• słownik używanych terminów
• indeks

To tak ogólnie. Chyba mniej więcej widać o co chodzi. Pamiętaj, że takie coś kosztuje i musisz to wliczyć w cenę systemu.