Technical Documentation for Non-Writers

• Brak specjalnych wymagań poza posiadaniem produktu lub usługi wymagającej dokumentacji technicznej.

Publiczność

• Osoby niebędące pisarzami (np. programiści, inżynierowie, kierownicy techniczni, projektanci, kierownicy produktu i projektu itp.

To prowadzone przez instruktora szkolenie na żywo (online lub na miejscu) jest przeznaczone dla osób, które chcą pisać dokumentację techniczną, ale nie mają doświadczenia wyszkolonego pisarza technicznego.

Po zakończeniu tego szkolenia uczestnicy będą w stanie

• Tworzenie treści technicznych, które są dokładne i przyjazne dla użytkownika.
• Przekształcanie złożonych informacji o produkcie w czytelne treści skoncentrowane na użytkowniku.
• Stosować narzędzia i techniki w celu maksymalizacji wydajności pisania.
• Rozumieć i nadzorować różne fazy projektu pisarskiego, w tym pisanie, korektę, tłumaczenie i publikację.
• Ukończenie projektów pisarskich na czas i zgodnie z wymaganiami.

Format kursu

• Interaktywny wykład i dyskusja.
• Dużo ćwiczeń i praktyki.
• Praktyczne ćwiczenia w środowisku laboratoryjnym na żywo.

Opcje dostosowywania kursu

• Aby zamówić niestandardowe szkolenie dla tego kursu, skontaktuj się z nami.

Wprowadzenie

• Tworzenie Documentation, które jest używane

Gromadzenie wymagań

• Jak spojrzeć na instrukcję obsługi oczami użytkownika?
• Gromadzenie i zrozumienie wymagań (wewnętrznych i zewnętrznych)
• Co uwzględnić w dokumentacji technicznej Documentation, a co pominąć?

Planowanie

• Planowanie projektu pisania tekstów technicznych
• Harmonogramy i cykl życia produktu

Pisanie

• Pisanie minimalnej wersji roboczej
• Sprawianie, by pisanie było zrozumiałe
• Znaczenie iteracji w procesie pisania

Struktura

• Struktura dokumentu
• Tworzenie treści Search

Wygląd

• Dodawanie ilustracji i diagramów
• Techniki formatowania i układu
• Korzystanie z typografii w celu zwiększenia czytelności

Narzędzia

• Korzystanie z narzędzi i szablonów technicznych Documentation

Rewizja

• Optymalizacja technicznego Documentation przepływu pracy
• Formalizacja procesu przeglądu i zmiany

Tłumaczenie

• Tłumaczenie i proces tłumaczenia

Publikacja

• Publikowanie dokumentu technicznego

Po opublikowaniu

• Uzyskiwanie opinii od użytkowników
• Aktualizacja i utrzymanie techniczne Documentation

Podsumowanie i wnioski