Dokumentacja programu

Dokumentacja programu pomaga ludziom podczas pracy na programie, jest to niezwykle ważna rzecz w aplikacji, ponieważ bez tego, wielu użytkowników mogłoby mieć problemy, aby korzystać z danego programu. Ważne jest to, aby dobrze umieścić dokumentację, powinna ona być też bardzo czytelna i łatwa w zrozumieniu, nawet dla osób, którzy nie zajmują się informatyką na co dzień. Dokumentacje programu dzieli się na: użytkownika (zwykle jest to pomoc, która wyjaśnia wszelkie problemy i pytania, co do wykonania jakieś czynności w programie, którą znajdziemy zazwyczaj w zakładce „pomoc” w menu pliku), a także techniczna (polega ona na pomocy osobom, które chcą zmodyfikować program dla własnych potrzeb, lub dla potrzeb innych użytkowników, przykładowo poprzez wprowadzenie kolejnej wersji programu). Dokumentacja pozwala na szybkie dowiedzenie się, co jest głównym problemem podczas naszej pracy, możemy znaleźć rozwiązanie, które SA nam potrzebne, jest ona zwykle ułożona w listę, której łatwo jest wyszukiwać poprzez alfabetyczne szukanie lub wpisanie wyrazu, który może określać dany problem, a dokumentacja odszukuje go i dzięki temu możemy w szybki sposób znaleźć rozwiązanie naszego problemu, jednak wielu ludzi woli zajrzeć do Internetu, niż do pomocy,, która jest zawarta w programie. Dokumentacja zazwyczaj jest podzielona na tematy, które pomagają nam w rozwiązywaniu problemów dla użytkowników, jak i programistów, którzy korzystają z programu, dla własnych celów lub do użytkowania przez inne osoby.

About the author