Techniczni pisarze tworzą różne rodzaje dokumentacji, na przykład podręczniki użytkownika, dokumentację API, przewodniki 'Jak to zrobić’ i tak dalej. Napisałem artykuł o tym, jak napisać podręcznik użytkownika, więc dzisiaj opowiem Ci o tworzeniu przewodnika 'Jak to zrobić’.
Gdy otrzymasz zadanie stworzenia przewodnika, Twoim pierwszym krokiem powinno być planowanie. Oto, co powinieneś zrobić:
Zrozumieć swoją grupę docelową
Gdy zaczniesz pisać swój przewodnik, powinieneś jasno zrozumieć, kim jest twoja grupa docelowa. Jaki jest ich wiek, jakie jest ich tło i tak dalej. To zdefiniuje styl Twojego przewodnika „Jak to zrobić” na najbardziej podstawowym poziomie – złożoność używanego języka, liczba terminów i wiele innych cech.
Badania nad procesem
Zalecam, abyś przeczytał o doświadczeniach innych ludzi w pisaniu przewodników „Jak to zrobić”. Pomoże Ci to uzyskać jasny obraz przyszłej pracy i będziesz mógł włączyć podejście innych do swojego procesu pracy. Na przykład, napisałem o procesie pisania technicznego Amrute Ranade, możesz przeczytać ten artykuł tutaj: 'Great Technical Writing Process’. Więc, możesz również użyć tej metody, aby ułatwić sobie pisanie techniczne.
Zbieraj przydatne materiały
Przed rozpoczęciem pisania, zbieraj materiały i informacje, które pomogą Ci napisać przewodnik „jak to zrobić”. Mogą to być dodatkowe informacje o produkcie, inne poradniki 'how-to’ o podobnych produktach lub coś innego.
Write Your 'How-to’ Guide
Przede wszystkim stwórz plan – łatwiej będzie napisać poradnik, jeśli go zwizualizujesz. Po tych wszystkich przygotowaniach, najwyższy czas zabrać się za pisanie. Tworząc poradnik, powinieneś pamiętać o następujących wskazówkach:
- Pisz prostym angielskim, aby mówić tym samym językiem, co Twoi czytelnicy.
- Twój język powinien być zawsze zwięzły (np, 'Wybierz opcję’ zamiast 'Powinieneś wybrać tę opcję’).
- Utwórz listy numerowane, aby uporządkować kroki, jeśli użytkownik musi je wykonać
- Dodaj treści wizualne, takie jak zdjęcia, zrzuty ekranu i diagramy.
- Podziel treść na sekcje z nagłówkami, ale pisz je wyraźnie
- Jeśli chcesz używać żartów, uważaj: ludzie mogą cię nie zrozumieć
- Dodaj mini-TOC, aby duże tematy były bardziej czytelne.
Najważniejsza wskazówka jest następująca – błędy ortograficzne i gramatyczne są niedopuszczalne w dokumentacji, więc dokładnie sprawdź swój przewodnik. Tutaj znajduje się lista najlepszych darmowych programów do sprawdzania gramatyki. Możesz również poprosić kogoś innego o korektę lub przeczytać własne kroki w odwrotnej kolejności, aby upewnić się, że twoje pismo jest jasne i proste. Oto kilka innych zasobów do pisania świetnej dokumentacji:
- Grammar Books for Technical Writers
- Style Guides for Technical Writers
Oczywiście, to nie jest wszystko, co trzeba wiedzieć o pisaniu przewodników 'How to’, ale te wskazówki są najbardziej istotne, według mnie. Mam nadzieję, że ci pomogą.
Powodzenia w pisaniu przewodników!