Rozwiązane

Etapy sporządzania i przykłady dokumentacji technicznej



Odpowiedź :

Odpowiedź:

1. Tworzenie planu dokumentacji.

Tytuł,

imię i nazwisko Technical Writera,

określenie typu dokumentacji (instrukcja, online help),

określenie daty zakończenia pracy nad dokumentacją,

krótki opis tego, czego dotyczy dokumentacja,

oszacowanie liczby stron – można wykorzystać do tego istniejące dokumenty o podobnej tematyce,

spis rozdziałów,

określenie etapów weryfikacji tekstu w trakcie prac.

2. Zbieranie informacji na dany temat.

3. Pisanie według ustalonego planu.

4. Weryfikacja stworzonego tekstu.

5. Poprawki oraz uzupełnianie luk.