Dokumentacja użytkownika - przykłady dobre i złe
Wyszperane w sieci... a właściwie na stronach małej, rodzinnej firmy Blue Mango Learning System, twórcy produktów ScreenSteps i Clarity.
Wyszperane w sieci... a właściwie na stronach małej, rodzinnej firmy Blue Mango Learning System, twórcy produktów ScreenSteps i Clarity.
Jedną z cech dobrego Technical Writera jest umiejętność pisania. Na tą umiejętność składają się różne elementy, takie jak prezentowanie informacji w sposób jasny i zrozumiały czy też uporządkowanie ich w logiczny sposób. Ale to nie wszystko. Liczy się również poprawność językowa. Pomimo tego, że jest ona na pewno mniej ważna niż dokładność przedstawianych informacji, to nie powinniśmy o niej zapominać. Wiadomo, w sytuacji kiedy mamy napięte terminy i musimy z czegoś zrezygnować, lepiej jest stworzyć dokumentację zawierającą błędy językowe, ale dokładną pod względem technicznym niż wzór poprawności językowej, który opisuje produkt "po łebkach".
Zgodnie z obietnicą, prezentujemy drugą porcję przydatnych informacji z książki „Technical Writing 101: A Real-World Guide to Planning and Writing Technical Documentation” autorstwa Alana S. Pringle i Sarah S. O’Keefe. Jest to kontynuacja dobrych rad, które przedstawiliśmy w poprzednim wpisie z cyklu "Naucz się sam(a)".