Ludzie dzielą się na tych, którzy są Tech Writerami i na tych, którzy nimi nie są. Proste. Tą drugą, liczniejszą grupę możemy z kolei podzielić na tych, którzy nie wiedzą czym się zajmuje Tech Writer i na tych, którym się wydaje, że wiedzą.
Umiecie odpowiednio posortować wyprane ubrania? Jeśli tak, to prawdopodobnie umiecie też pisać dokumentację. Brzmi dość dziwnie, jednak okazuje się, że te dwa procesy mogą mieć ze sobą wiele wspólnego.
Dokumentacja, która jest dokładna pod względem merytorycznym to sprawdzone źródło informacji o produkcie, które podnosi wiarygodność Twojej firmy. Nieaktualne informacje mogą wpłynąć niekorzystnie na tempo rozwoju produktu oraz na klientów, którzy nie będą w stanie rozwiązać swoich problemów sięgając po dokumentację. Nieścisłości napotkane w dokumentacji wydłużają również czas potrzebny do opanowania produktu. Portal TechRepublic w jednym z artykułów daje nam wskazówki jak radzić sobie z recenzją merytoryczną dokumentacji. Poniżej przedstawiamy naszą "skondensowaną" wersję 😊
Tom Johnson jakiś czas temu pokusił się o stworzenie listy dziesięciu zasad, których według niego powinniśmy się trzymać kiedy tworzymy dokumentację. Poniżej prezentujemy streszczenie tego dekalogu oraz nasze krótkie przemyślenia na jego temat. Oryginalny artykuł dostępny jest tutaj.