Tag: Manuale

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




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…




Wyszukiwanie w wielu plikach PDF

Jak wyszukać jakieś wyrażenie w wielu plikach PDF naraz? Można otworzyć każdy plik z osobna za pomocą przeglądarki plików PDF, nacisnąć Ctrl+F i wyszukać żądany tekst. Taka metoda jest oczywiście mało wydajna i w przypadku dużej ilości plików niezwykle czasochłonna. Okazuje się, że jest dużo prostszy sposób, który nie wymaga instalowania płatnych aplikacji….


Tags:


Pierwszy technical writer?

W środowisku krążą plotki o tym, że pierwszy techwriter był lowelasem. Nie wierzcie w to….




Jak pisać dobre instrukcje?

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




Help and Manual – niepotrzebne obrazki

Help and Manual posiada dużo przydatnych funkcji, których nie widać gołym okiem. Jedną z nich jest możliwość sprawdzenia, które obrazki nie są używane w projekcie….




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




Czy warto znać narzędzia do tworzenia dokumentacji?

W pracy każdego Technical Writera przychodzi co jakiś czas moment wytchnienia. Możemy złapać spokojnie oddech i zwolnić tempo. Pojawia się trochę wolnego czasu. Jedni chcą wtedy po prostu cieszyć się chwilą, ale inni wolą ten czas spożytkować na naukę obsługi nowych narzędzi do tworzenia dokumentacji Help Authoring Tools….




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