• Artykuły
  • Forum
  • Ciekawostki
  • Encyklopedia
  • Dokumentacja programu

    Przeczytaj także...
    Programista, zwany też potocznie koderem to osoba, która tworzy programy komputerowe w pewnym języku programowania. Termin ten może odnosić się także do specjalisty w jednej dziedzinie programowania. Większość programistów zna co najmniej kilka języków programowania (np. C, C++, Java), lecz specjalizuje się tylko w wybranych z nich. Nazwa głównego języka jest często dodawana do nazwy stanowiska, np. programista C++, aby podkreślić specjalizację.Format otwarty UML (ang. Unified Modeling Language, czyli Zunifikowany Język Modelowania) – język formalny wykorzystywany do modelowania różnego rodzaju systemów, stworzony przez Grady Boocha, Jamesa Rumbaugha oraz Ivara Jackobsona, obecnie rozwijany przez Object Management Group.
    Dokument – w uogólnionej definicji rzeczowe świadectwo jakiegoś zjawiska sporządzone w formie właściwej dla danego czasu i miejsca.

    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.Plik (ang. file) – uporządkowany zbiór danych o skończonej długości, posiadający szereg atrybutów i stanowiący dla użytkownika systemu operacyjnego całość. Nazwa pliku nie jest częścią tego pliku, 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.

    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



  • w oparciu o Wikipedię (licencja GFDL, CC-BY-SA 3.0, autorzy, historia, edycja)

    Warto wiedzieć że... beta

    Definicja intuicyjna: Kod źródłowy to zapis programu komputerowego w formie czytelnej dla człowieka umożliwiający jego modyfikację i rozwój.
    System zarządzania dokumentami (ang. Document Management System) – narzędzie informatyczne pozwalające na przetwarzanie wszelkich form dokumentów powstających w organizacjach. Przetwarzanie dotyczy zarówno dokumentów wewnętrznych dotyczących współpracy różnych obszarów funkcjonalnych organizacji, jak również dokumentów napływających z otoczenia (np. zamówienia od klientów, faktury, listy i inne). W zakresie zarządzania wiedzą techniki te w szczególny sposób wspomagają obszar gromadzenia i organizowania zasobów wiedzy.
    Doxygen to generator dokumentacji dla języków C++, C, Java, Objective-C, Python, IDL, Fortran i do pewnego stopnia dla PHP, C#, D oraz ActionScript. Obsługuje następujące formaty wyjściowe: HTML, CHM, RTF, PDF, LaTeX, PostScript oraz strony man
    Skrót – skrócony zapis wyrazu lub wyrażenia, zbudowany z jednej lub kilku liter (inna nazwa to: abrewiatura). Skróty zapisuje się stosownie do obowiązujących dla danego języka norm ortograficznych, przyjętych zwyczajowo konwencji pisowni dla konkretnych skrótów (różne znaczenia, wyjątki) lub w sposób swoisty dla skrótów nazw własnych – szczególnie jeśli są to skróty stosowane w odniesieniu do podmiotów gospodarczych i instytucji.
    Dokumentacja użytkownika – jeden z rodzajów dokumentacji nieaktowej. Występuje w postaci plików pomocy: opisów oraz rysunków służących obsłudze, pomocy oraz konfiguracji konkretnej aplikacji bądź systemu operacyjnego. Zawierają także ich ogólny opis. Jest głównie przechowywana w dokumentacji danego oprogramowania. Są najczęściej pisane w języku angielskim.
    Algorytm – w matematyce skończony ciąg jasno zdefiniowanych czynności, koniecznych do wykonania pewnego rodzaju zadań. Słowo "algorytm" pochodzi od starego angielskiego słowa algorism, oznaczającego wykonywanie działań przy pomocy liczb arabskich (w odróżnieniu od abacism – przy pomocy abakusa), które z kolei wzięło się od nazwiska, które nosił Muhammad ibn Musa al-Chuwarizmi (أبو عبد الله محمد بن موسى الخوارزمي), matematyk perski z IX wieku.
    RTFM – popularny akronim wyrażenia Read The Fucking Manual (ang. przeczytaj (tę) pierdoloną dokumentację lub (ten) pierdolony podręcznik).

    Reklama

    Czas generowania strony: 0.049 sek.