Jeśli masz za zadanie napisać dokument, który powinien instruować kogoś innego, jak coś zrobić, dzisiejszy sposób robienia mniej więcej wyrzuca stare metody za okno.
1. Duże bombastyczne nagłówki
Zauważysz, że nagłówki na PCMech, takie jak ten tuż nad tym zdaniem, są ogromne. Jest tak, ponieważ łatwiej jest je zobaczyć, przeczytać i wiedzieć, gdzie jesteś w dokumencie.
2. Mniej słów
Zła droga:
Poniższa dokumentacja wyjaśnia, jak używać i obsługiwać Fanny Whacker 2000.
Właściwa droga:
Instrukcje dotyczące korzystania z Fanny Whacker 2000
Zawsze pamiętaj o tym fakcie podczas pisania dokumentacji: DOSTAJ SIĘ DO PUNKTU SZYBKO, JAK MOŻLIWE.
3. Pomiń niepotrzebne odniesienia
Jeśli odwołanie nie ma nic wspólnego z podstawową instrukcją tego, co próbujesz opisać, na przykład:
Aby uzyskać więcej informacji o Fanny Whacker 2000's Turnip Twaddler, zobacz dokument FU, podrozdział ID10T.
… Nie rób tego.
4. Data to. Zawsze.
Data napisania dokumentacji powinna znajdować się w stopce każdej strony. Jeśli jest to dokument elektroniczny, data jest wyświetlana dwukrotnie. Raz na początku, raz na końcu.
Możesz to napisać jako „Ostatnia aktualizacja (wstaw datę tutaj)”.
5. Ostrzeżenia należy zawsze umieszczać przed punktem braku zwrotu
Jeśli w twojej dokumentacji jest coś, co może potencjalnie uszkodzić / zniszczyć / zatrzeć coś, jeśli zostanie wykonane nieprawidłowo, informacje te powinny zostać umieszczone bezpośrednio po tej instrukcji, znajdować się na widoku (to znaczy na tej samej stronie) i akcentowane.
Przykład:
Krok 5. Czyszczenie Fanny Whacker 2000
Łopatki FW2000 należy delikatnie czyścić miękką ściereczką nieścierającą.
OSTRZEŻENIE: Używaj wyłącznie rozpuszczalnika niezawierającego amoniaku, aby zapobiec wybuchowi FW2000 i przedwczesnej śmierci.
Podsumowując, dobra dokumentacja nie polega na tym, że jest superopisowa na temat każdej możliwej rzeczy, jaką można sobie wyobrazić. Przeczytaj swoją dokumentację i zadaj sobie pytanie, czy właściwie instruuje? Jeśli odpowiedź brzmi „tak”, następne pytanie brzmi: czy instruuje szybko ? Jeśli tak, dokumentacja jest dobra.
