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.
Termin oddania projektu coraz bliżej, a nasza dokumentacja nie przeszła jeszcze korekty. Czasu jest mało, a pracy jak zwykle za dużo. Nie ma szans na przeczytanie wszystkiego od deski do deski. Trzeba szukać innego rozwiązania. Na szczęście z pomocą przychodzi nam Technical Communication at UAHuntsville ze swoim pomysłem na mocno przyspieszoną wersję korekty, która może się przydać w sytuacjach awaryjnych.
Bycie Technical Writerem jest fajne. Przynajmniej według nas. Jest to zawód nietuzinkowy, dający satysfakcję i poszerzający wiedzę techniczną, szczególnie dla osób, które ukończyły studia humanistyczne. Jednak nie zawsze jest tak różowo. Dzisiaj chcemy wylać trochę żali i podzielić się z Wami tym, z czym Technical Writer musi się mierzyć. Dla jednych są to problemy, dla innych wyzwania. Bez względu na to, jakiego określenia użyjemy, są to "ciemne strony" tego zawodu, o których też trzeba mówić. Dzięki temu możemy podpowiedzieć innym jak sobie radzić w trudnych sytuacjach. Problemy są różne, dlatego nasza lista w żadnym wypadku nie wyczerpuje tematu. Jest to jedynie zestawienie, które zbudowaliśmy na podstawie własnych doświadczeń. Nie chcemy nikogo zniechęcać do zawodu Technical Writera, a jedynie uświadomić, że to nie zawsze plaża i drinki ze słomką 😉
Pisanie instrukcji to nic trudnego. Pisanie dobrych instrukcji to całkowicie inna historia. To nie lada wyzwanie wymagające odpowiedniego podejścia i umiejętności. Dzisiaj chcemy Wam przedstawić kilka wskazówek jak pisać skuteczne instrukcje. Przepis pochodzi z blogu Laury Schneider. Oryginalny artykuł można znaleźć tutaj. Poniżej przedstawiamy streszczenio-tłumaczenio-interpretację tegoż artykułu. 😊
Podejście minimalistyczne w pisaniu dokumentacji jest jak najbardziej wskazane, o czym wspominaliśmy w jednym z postów jakiś czas temu. Długie, skomplikowane i przeładowane informacjami instrukcje to samo zło, którego należy unikać.