PICT0583 resize

iausy^jauii&su

ubiu

Jakość dokumentacji

Na jakość dokumentacji wpływają następujące czynniki:

-Struktura. Poszczególne podręczniki powinny być w czytelny i zrozumiały sposób podzielone na rozdziały, podrozdziały i sekcje.

-Zachowanie standardów. Poszczególne podręczniki oraz fragmenty tego samego podręcznika powinny mieć spójną strukturę, formę i sposób pisania.

I

- Sposób pisania.

Na jakość sposobu pisania wpływają następujące elementy:

-Stosowanie formy aktywnej oraz zwracanie się bezpośrednio do czytelnika. Wynika z tego. źe zamiast zdań:

Na ekranie pojawi się dialog...

Aby otworzyć pik należy wybrać z menu... powinny się pojawić zdania:

Na ekranie zobaczysz dialog...

Jeżel chcesz otworzyć pik. wybierz z menu...