Legjobb válasz
Olyan sokféle műszaki dokumentum létezik, hogy szinte lehetetlen mindegyiket ide felsorolni.
Hosszú műszaki írói pályafutásom során személyesen több mint 15 különböző típusú műszaki dokumentumot kellett megírnom, projektenként változóan.
A legelvontabb szinten a műszaki dokumentumok a belső felhasználók és a külső végfelhasználók számára írt kategóriákba kell sorolni.
Például egy Rendszerkonfigurációs útmutató egy példa egy „belső” dokumentumra, míg egy A Telepítési útmutató egy példa a „külső végfelhasználó” dokumentumra.
A API útmutató egyaránt használható belső használatra és külső felhasználók. A gyors üzembe helyezési útmutató viszont szinte mindig külső végfelhasználóknak szól.
Írtam Felhasználói útmutatók , Hibaelhárítási útmutatók , Referencia lapok , Kiadási megjegyzések , (szerkesztve) Marketing követelményeket tartalmazó dokumentumok (MRD), Építészeti és műszaki dokumentumok (A&E Doc), Súgó fájlok , Normál üzemeltetési eljárás (SOP) kézikönyvek és még sok más.
Örömmel látogat el a Műszaki Kommunikációs Központba további és ingyenes információkért a különböző típusú műszaki dokumentumokról.
Válasz
A létező műszaki dokumentáció típusainak kategorizálása különböző módon lehetséges. Nem állítom, hogy ismerem mindet, de a két fő tág kategória, amellyel bármilyen műszaki dokumentációt kategorizálhat, a felhasználó és a felhasználási eset.
„A felhasználó” alatt azt értem, amit a felhasználó típusa fogja használni a dokumentumot? Rendszergazda útmutató, oktatóanyag vagy felhasználói útmutató? Ezeket a tudásszinteket figyelembe veszik egy dokumentum megtervezésekor. Az adminisztrátori útmutató feltételezi, hogy a dokumentumot olvasó személy valamivel többet tud, mint az oktatóanyag olvasója.
A „használati eset” alatt azt értem, hogy mire használják a dokumentumot? Ez terjedhet a rakéták indításának katonai dokumentációjától egészen a fejlesztői dokumentációig, hogy miként lehet grafikus API-t használni egy videojáték fejlesztéséhez.
Ha szűkítheti kérdését, akkor képes leszek hogy többet nyújtson abból, amit keres.