Tag: Instrukcje

Pisanie dokumentów jest jak sortowanie wypranych ubrań

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….




Jak sobie radzić z recenzją merytoryczną dokumentacji?

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….




Dekalog Tech Writera

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….




Czym zajmuje się technical writer?

Dziś na chwilę wrócimy do podstaw. Szczególnie, że mamy okazję podać je w łatwo przyswajalnej formie. Obejrzyjcie i posłuchajcie na czym polega praca techwritera….




Korekta w tempie Pendolino

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…




Minimalizm – poziom ekspert

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ć….




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….




UA Conference – Agnieszka Tkaczyk

Agnieszka Tkaczyk rozpoczęła swoją przygodę z dokumentacją techniczną zaledwie parę lat temu, a już na swoim koncie ma dwie prezentacje na branżowych konferencjach. O pierwszej pisaliśmy tutaj, teraz możecie przeczytać o kolejnej: A Technical Writer’s Role in Redesigning the Application UI….




UA Conference – Relacji Ciąg Dalszy

Zapraszamy na kolejną relację z UA Conference. Dzisiaj nasze podsumowanie dwóch prezentacji: Maximizing the Effect of Progressive Disclosure (Jang F.M. Graat) oraz Designing Transactions Successfully (Dr Chris Atherton)….




Podręcznik stylu – stylręcznik?

A może po prostu Style Guide lub Style Manual? Dowiedz się co to jest, sprawdź do czego i kiedy jest potrzebne, stwórz Style Guide dla swojej organizacji. O ile jeszcze go nie ma….