Movatterモバイル変換


[0]ホーム

URL:


Przejdź do zawartości
Wikipediawolna encyklopedia
Szukaj

Dokumentacja programu

Z Wikipedii, wolnej encyklopedii

Dokumentacja programu – ogółdokumentacji technicznej idokumentacji użytkownika stworzonej dla określonegoprogramu 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 dlaprogramistó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 zkodu ź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, zang. human-readable(inne języki)), choć w zależności od wymagań i rodzaju dokumentacji wskazane może być posiłkowanie siędokumentami niepiśmienniczymi, takimi jak fragmentykodów źródłowych,wykresy, graficzne reprezentacjealgorytmów, zdjęcia interfejsu użytkownika,diagramy przepływu, opisyUML czyXML).

Również użytkownicy niechętnie korzystają z dokumentacji – przypomina o tym stosowany w odpowiedzi na niektóre (zwłaszcza banalne) pytaniaskrótRTFM.

Zobacz też

[edytuj |edytuj kod]

Linki zewnętrzne

[edytuj |edytuj kod]
Źródło: „https://pl.wikipedia.org/w/index.php?title=Dokumentacja_programu&oldid=75524377
Kategorie:
Ukryta kategoria:

[8]ページ先頭

©2009-2026 Movatter.jp