Dokumentacja programu - Polski Serwis Naukowy

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.

Wykres – graficzna forma przedstawienia zmienności zjawiska, procesu, wielkości, zależności lub jakichkolwiek danych. Zwykle przedstawiany w dwóch wymiarach, ale może być wielowymiarowy. Często używany w naukach przyrodniczych.

Plik (ang. file), jest to ciąg danych (inaczej zbiór danych), o skończonej długości, posiadający szereg atrybutów i stanowiący dla systemu operacyjnego całość. Nazwa pliku nie należy do niego, lecz jest przechowywana w systemie plików.

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).

XML (ang. Extensible Markup Language, w wolnym tłumaczeniu Rozszerzalny Język Znaczników) – uniwersalny język formalny przeznaczony do reprezentowania różnych danych w strukturalizowany sposób.

Dokumentacja techniczna - jeden z rodzajów dokumentacji nieaktowej. Występuje w postaci opisów technicznych, obliczeń konstrukcyjnych, rysunków, planów, kosztorysów i harmonogramów. Przechowywana jest w archiwach użytkowników, inwestorów, wykonawców inwestycji, w archiwach instytucji, które w zakresie swoich kompetencji mają wydawanie zezwoleń budowlanych oraz archiwach jednostek projektowania. Generalnie rzecz ujmując, dokumentacja techniczna służy do realizacji inwestycji, utrzymania obiektów w dobrym stanie technicznym, do produkcji określonych wyrobów, utrzymania w ruchu linii technologicznych, a także dla zachowania sprawności pojedynczych urządzeń. W zależności od miejsca jej przechowywania ma ona różne okresy przechowywania. Decydują o tym kwalifikatory, zatwierdzane dla państwowych jednostek projektowania przez archiwa państwowe. O ile dokumentacja ta nie została zakwalifikowana do kategorii A, nakazuje się przechowywanie jej użytkownikom, zarządcom budynków i instytucjom wydającym pozwolenia budowlane, przez okres istnienia obiektu i dodatkowo przez okres pięciu lat po jego zburzeniu, utracie czy zaprzestaniu eksploatacji.

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.

Zobacz też

system zarządzania dokumentami

system kontroli wersji

Linki zewnętrzne

Biblioteka dokumentacji technicznej