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
| Nowak: nazwiskiem Sikorskiego nie można żonglować |
Rząd zgłosi kandydaturę Radosława Sikorskiego na sekretarza generalnego NATO tylko wtedy, kiedy będzie miał pewność powodzenia jego kandydatury. - Powinniśmy zabiegać, ale po cichu - uważa Sławomir Nowak. |
| J.Kaczyński: PiS przedstawi propozycje w sprawie kryzysu |
- Prawo i Sprawiedliwość przedstawi w czwartek propozycje dotyczące działań w czasie kryzysu gospodarczego - zapowiedział w radiowej "Trójce" prezes PiS Jarosław Kaczyński. "Co uczynić, aby Polska gospodarka ucierpiała możliwie jak najmniej" - dodał. |
| Z klubu PiS odszedł kolejny poseł |
Andrzej Walkowiak, poseł z Bydgoszczy, przeszedł z sejmowego klubu PiS do koła Polska XXI - podało Radio Zet. |
| Kurski: Kryzys gazowy, a Tusk w Dolomitach. Kompromitacja |
- Jest jedna wielka kompromitacja, bo kiedy dzieją się te napięcia gazowe, gdzie pan premier Donald Tusk? Na nartach w Dolomitach! - oburzał się w "Kontrwywiadzie" RMF poseł PiS Jacek Kurski. W radiu ZET premiera bronił szef jego gabinetu politycznego: - Trzy dni urlopu trudno uznać za jakieś szałowe wakacje - mówił Sławomir Nowak. |
| Wywiad z Sikorskim: Nie zaostrzać dyskursu z Rosją |
W wywiadzie dla "Gazety Wyborczej" Radosław Sikorski, minister spraw zagranicznych, mówi o zaangażowaniu Unii Europejskiej w gazowy konflikt między Rosją i Ukrainą oraz o realizacji energetycznych celów Polski we Wspólnocie. Ujawnia też, że Ukraina przegapiła szansę na otrzymanie planu na rzecz członkostwa w NATO. |
| Śliski poranek: wypadki na drogach |
Odblokowana jest już droga krajowa nr 10 przy wjeździe na obwodnicę Torunia w Lubiczu, gdzie zderzyły się cztery samochody. Jedna osoba została ranna. W Małopolsce autobus z górnikami wjechał w drzewo. |
| Gehenna z meldunkiem przejdzie do lamusa? |
Zamiast obowiązku meldunkowego wprowadzimy uproszczone formalności; zarejestrowania pobytu będzie można dokonać drogą elektroniczną - mówi w wywiadzie dla "Gazety Prawnej" wiceminister SWiA Witold Drożdż. |
| Farfał: zmiana w TVP nie była zaaranżowana |
Nowy szef TVP Piotr Farfał zapewnia w "Dzienniku", że pochodzące z PiS sugestie, iż zmiana zarządu telewizji publicznej była zaaranżowana w budynkach ministerialnych, jest nieprawdziwa. |
| Abp Kowalczyk i o. Hejmo mieli jednego opiekuna? |
Dzisiejszy nuncjusz apostolski w Polsce apb Józef Kowalczyk, którego tajne służby PRL zarejestrowały bez jego wiedzy jako kontakt informacyjny, przekazywał informacje temu samemu rezydentowi wywiadu co ojciec Konrad Hejmo - donosi „Rzeczpospolita". |
| Tomasz Nałęcz wraca do polityki |
Tomasz Nałęcz przyjął zaproszenie na inauguracyjne spotkanie koalicji SdPl - PD - Zieloni firmowanej przez Dariusza Rosatiego, Janusza Onyszkiewicza i Marka Borowskiego. - Zgodził się uczestniczyć w budowie nowej centrolewicy - twierdzą organizatorzy. |
