Dokumentacja programu
Z Wikipedii
Dokumentacja programu to ogół dokumentacji technicznej i dokumentacji użytkownika stworzonej dla określonego programu komputerowego przez jego twórców.
W jej skład wchodzą:
- dokumentacja użytkownika to opis programu przeznaczony dla jego użytkownika. Składają się na nią np. pliki pomocy, ogólne informacje o programie i jego sposobie obsługi.
- dokumentacja techniczna jest przeznaczona dla osób, które mogą potrzebować modyfikować program. Zawiera dokładny opis metody działania programu, algorytmów w nim zastosowanych, rozmieszczenia i sposobu działania poszczególnych komponentów itp. Ze względu na swoją naturę jest ona przeznaczona dla programistów, a dla zwykłego użytkownika właściwie niezrozumiała.
Tradycyjnie pisanie dokumentacji jest czynnością wykonywaną przez programistów niechętnie, stąd powstają systemy automatycznego generowania dokumentacji technicznej wprost z kodu źródłowego, np. doxygen.
Dokumentacja programu powinna w swojej podstawie zawierać dokumenty piśmiennicze (w języku naturalnym, w formie zrozumiałej dla człowieka, z ang. human readable), choć w zależności od wymagań i rodzaju dokumentacji wskazane może być posiłkowanie się dokumentami niepiśmienniczymi, takimi jak fragmenty kodów źródłowych, wykresy, graficzne reprezentacje algorytmów, zdjęcia interfejsu użytkownika, diagramy przepływu, opisy UML czy XML).
Również użytkownicy niechętnie korzystają z dokumentacji - przypomina o tym stosowany w odpowiedzi na niektóre (zwłaszcza banalne) pytania skrót RTFM.
[edytuj] Linki zewnętrzne
| Pierwsza ofiara powodzi na Podkarpaciu |
|
35-letni mieszkaniec Jabłonki w powiecie brzozowskim jest prawdopodobnie pierwszą ofiarą powodzi na Podkarpaciu. Ciało Grzegorza P. wyłowiono po południu z potoku Dydnianka, który wpada do Sanu.
|
| Szymanek-Deresz proponuje ponadpartyjne prace nad ustawÄ… medialnÄ… |
|
Jolanta Szymanek-Deresz (SLD) oceniła - dzień po tym jak Sejm podtrzymał weto prezydenta do ustawy medialnej - że obecnie jest dobry moment, aby rozpocząć prace nad ustawą medialną w układzie ponadpartyjnym, z uwzględnieniem postulatów Sojuszu.
|
| "Niektóre wyroki ws. dziennikarzy mają charakter przypadkowy" |
|
Zdaniem medioznawcy, profesora Wiesława Godzica, niektóre wyroki zapadające w Polsce w sprawach dotyczących dziennikarzy mają charakter przypadkowy, i są efektem braku wiedzy sędziów o zasadach działania wolnych mediów.
|
| Szef SLD: "palikotyzacja" PO z siłą huraganu |
|
- Szef klubu PO, Zbigniew Chlebowski najwyraźniej bierze przykład ze swojego kolegi, posła Janusza Palikota (...). W polityce jednak warto zachować umiar i nie licytować się z posłem Palikotem - pisze na swoim blogu w Onet.pl Grzegorz Napieralski, przewodniczący Sojuszu Lewicy Demokratycznej.
|
| "On jak śpi, to kłamie; PO nie rozmawia z hipokrytą" |
|
- Jak Å›mie pan Napieralski mówić, że nie dajÄ… (SLD - red.) partyjnej legitymacji telewizji publicznej, a obecna telewizja, która jest PiS-owskim komitetem wyborczym - mówiÄ™ o publicystyce - miejscami przypomina publicystykÄ™ stanu wojennego - jest caÅ‚kowicie jednostronna, PiS-owska, zakÅ‚amana – oburzaÅ‚ siÄ™ w TVN24 Stefan NiesioÅ‚owski.
|