dokumentacj

Dokumentacja to zbiór materiałów opisujących cechy, funkcje, interfejsy, instalację, konfigurację i utrzymanie danego systemu lub produktu. W języku polskim prawidłową formą jest dokumentacja, a forma skrócona „dokumentacj” zwykle występuje jako błędna pisownia lub skrót w specyficznych kontekstach. Dokumentacja ma na celu przekazywanie wiedzy użytkownikom, administratorom i programistom, ułatwienie obsługi oraz wspieranie powtarzalności i zgodności z wymaganiami.

Najważniejsze rodzaje dokumentacji to dokumentacja użytkownika, która opisuje sposób obsługi i funkcje produktu; dokumentacja programistyczna (API,

Typowa zawartość obejmuje opis funkcji, wymagania systemowe, instrukcje instalacji i konfiguracji, przykłady użycia, interfejsy programistyczne, diagramy

Proces tworzenia dokumentacji zwykle łączy pracę autorów z zespołami deweloperskimi i testerami, obejmuje przeglądy, zatwierdzanie, publikację

i

i

i

konfiguracyjne,

i

i

reStructuredText),

i

w

i

z