O usłudze
PrzetłumaczonePiszę dokumentację techniczną i pomoc produktu, którą ludzie naprawdę czytają: podręcznik użytkownika, centrum pomocy, dokumentację API. Praca zaczyna się od rozłożenia produktu na części. Przechodzę przez niego tak, jak nowy użytkownik, zapisuję każde miejsce, w którym utknąłem, i zbieram rzeczywiste zadania, z którymi przychodzą twoi użytkownicy. Struktura wyrasta z tych zadań, a nie z twojego drzewa menu: najpierw uruchomienie i pierwsze małe zwycięstwo, potem codzienna praca, a dopiero później złożone scenariusze, które potrzebuje niewielu, ale które pochłaniają większość czasu zespołu wsparcia.
Każdy artykuł to zestaw kroków z zrzutami ekranu, opisany tak, aby czytelnik nigdy nie musiał zgadywać, który przycisk jest zamierzony. Osobna sekcja dotyczy powszechnych błędów i co z nimi zrobić: tekst na ekranie, powód jego wystąpienia, sposób wyjścia. Część API zawiera przykłady żądań i odpowiedzi dla każdej metody, wyjaśnia pola i kody statusu oraz jasno mówi, co wraca w przypadku błędu. Słownik gromadzi terminy produktowe w jednym miejscu, aby interfejs, pomoc i odpowiedzi wsparcia używały tych samych słów, a krótki przewodnik po stylu ustala ton i sformułowania, aby tekst pozostawał w jednej tonacji, nawet gdy inni dodają do niego później.
Każda instrukcja jest weryfikowana poprzez przejście przez kroki na żywym produkcie; nic, co zostało napisane z pamięci dewelopera, bez tego przeglądu, nie trafia do pomocy. Klucze, tokeny i dane testowe w przykładach są zastępowane miejscami. Dokumentacja dla niedokończonej funkcji jest oznaczona jako szkic i nigdy nie jest przedstawiana jako gotowa.
— przegląd produktu i lista rzeczywistych zadań użytkowników
— struktura pomocy od pierwszego uruchomienia do zaawansowanych scenariuszy
— instrukcje krok po kroku z zrzutami ekranu i podpisami
— sekcja o powszechnych błędach i co z nimi zrobić
— dokumentacja API z przykładami żądań i odpowiedzi
— słownik terminów oraz krótki przewodnik po stylu i tonie
— każda instrukcja ponownie sprawdzona na żywym produkcie
— źródła przekazane w formacie łatwym do dalszej edycji
Każdy artykuł to zestaw kroków z zrzutami ekranu, opisany tak, aby czytelnik nigdy nie musiał zgadywać, który przycisk jest zamierzony. Osobna sekcja dotyczy powszechnych błędów i co z nimi zrobić: tekst na ekranie, powód jego wystąpienia, sposób wyjścia. Część API zawiera przykłady żądań i odpowiedzi dla każdej metody, wyjaśnia pola i kody statusu oraz jasno mówi, co wraca w przypadku błędu. Słownik gromadzi terminy produktowe w jednym miejscu, aby interfejs, pomoc i odpowiedzi wsparcia używały tych samych słów, a krótki przewodnik po stylu ustala ton i sformułowania, aby tekst pozostawał w jednej tonacji, nawet gdy inni dodają do niego później.
Każda instrukcja jest weryfikowana poprzez przejście przez kroki na żywym produkcie; nic, co zostało napisane z pamięci dewelopera, bez tego przeglądu, nie trafia do pomocy. Klucze, tokeny i dane testowe w przykładach są zastępowane miejscami. Dokumentacja dla niedokończonej funkcji jest oznaczona jako szkic i nigdy nie jest przedstawiana jako gotowa.
— przegląd produktu i lista rzeczywistych zadań użytkowników
— struktura pomocy od pierwszego uruchomienia do zaawansowanych scenariuszy
— instrukcje krok po kroku z zrzutami ekranu i podpisami
— sekcja o powszechnych błędach i co z nimi zrobić
— dokumentacja API z przykładami żądań i odpowiedzi
— słownik terminów oraz krótki przewodnik po stylu i tonie
— każda instrukcja ponownie sprawdzona na żywym produkcie
— źródła przekazane w formacie łatwym do dalszej edycji
