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, architektura, modele danych), która ułatwia rozwój i integracje; dokumentacja techniczna i instalacyjna, przewodniki konfiguracyjne oraz podręczniki operacyjne i rozwiązywanie problemów.

Typowa zawartość obejmuje opis funkcji, wymagania systemowe, instrukcje instalacji i konfiguracji, przykłady użycia, interfejsy programistyczne, diagramy architektury, dane konfiguracyjne, procedury testowe i metryki jakości. Dobre praktyki to jasność, spójność terminologii, aktualność oraz łatwość wyszukiwania.

Proces tworzenia dokumentacji zwykle łączy pracę autorów z zespołami deweloperskimi i testerami, obejmuje przeglądy, zatwierdzanie, publikację i utrzymanie. Do popularnych narzędzi należą języki znaczników (Markdown, reStructuredText), systemy makietowania (DITA, DocBook) oraz generatory dokumentacji i platformy wiki. Dokumentacja odgrywa kluczową rolę w projektach IT, projektach open source i zgodności z regulacjami.