Najlepsza odpowiedź
Jest tak wiele różnych typów dokumentów technicznych, że prawie niemożliwe jest ich wszystkie tutaj.
Podczas mojej długiej kariery pisarza technicznego osobiście musiałem napisać ponad 15 różnych typów dokumentów technicznych, różniących się w zależności od projektu.
Na najbardziej abstrakcyjnym poziomie dokumenty techniczne mogą być podzielone na te napisane dla użytkowników wewnętrznych i zewnętrznych użytkowników końcowych .
Na przykład Podręcznik konfiguracji systemu jest przykładem dokumentu „wewnętrznego”, natomiast Podręcznik instalacji to przykład dokumentu „zewnętrznego użytkownika końcowego”.
Przewodnik po interfejsie API może służyć zarówno do użytku wewnętrznego i użytkowników zewnętrznych. Z drugiej strony Szybki start jest prawie zawsze przeznaczony dla zewnętrznych użytkowników końcowych.
Napisałem Podręczniki użytkownika , Przewodniki rozwiązywania problemów , Arkusze informacyjne , Uwagi do wydania , (edytowano) Dokumenty wymagań marketingowych (MRD), Dokumenty architektoniczne i inżynierskie (Dokument A&E), Pliki pomocy , Standardowe instrukcje obsługi (SOP) i nie tylko.
Zapraszamy do odwiedzenia Centrum komunikacji technicznej w celu uzyskania większej ilości bezpłatnych informacji na temat wszystkich tych różnych typów dokumentów technicznych.
Odpowiedź
Istnieją różne sposoby kategoryzowania typów istniejącej dokumentacji technicznej. Nie udaję, że znam je wszystkie, ale dwie główne szerokie kategorie, których można użyć do kategoryzacji dowolnej dokumentacji technicznej, to użytkownik i przypadek użycia.
Przez „użytkownik” mam na myśli to, co typ użytkownika, który będzie używał dokumentu? Czy jest to podręcznik administratora, samouczek czy podręcznik użytkownika? Te poziomy wiedzy są brane pod uwagę podczas projektowania dokumentu. Przewodnik administratora zakłada, że osoba czytająca dokument wie nieco więcej niż czytelnik samouczka.
Przez „przypadek użycia” rozumiem, do czego służy dokument? Może to obejmować dokumentację wojskową dotyczącą sposobu wystrzelenia pocisku, aż po dokumentację programisty dotyczącą korzystania z graficznego interfejsu API do tworzenia gier wideo.
Jeśli potrafisz zawęzić swoje pytanie, być może będę w stanie aby dać Ci więcej tego, czego szukasz.