La mejor respuesta
Hay tantos tipos diferentes de documentos técnicos que es casi imposible enumerarlos todos aquí.
Durante mi larga carrera como redactor técnico, personalmente debo haber escrito más de 15 tipos diferentes de documentos técnicos, que varían de un proyecto a otro.
En el nivel más abstracto, los documentos técnicos pueden ser categorizados en aquellos escritos para los usuarios internos y usuarios finales externos .
Por ejemplo, una Guía de configuración del sistema es un ejemplo de un documento «interno» mientras que una La Guía de instalación es un ejemplo de un documento de «usuario final externo».
Una API Guide puede ser tanto para uso interno y usuarios externos. Una Guía de inicio rápido , por otro lado, casi siempre está destinada a usuarios finales externos.
He escrito Guías de usuario , Guías de solución de problemas , Hojas de referencia , Notas de la versión , (editado) Documentos de requisitos de marketing (MRD), Documentos de arquitectura e ingeniería (A&E Doc), Archivos de ayuda , Manuales de procedimientos operativos estándar (SOP) y más.
Le invitamos a visitar el Centro de comunicación técnica para obtener más información gratuita sobre todos estos diferentes tipos de documentos técnicos.
Responder
Hay diferentes formas de categorizar los tipos de documentación técnica que existen. No pretendo conocerlos todos, pero las dos categorías amplias principales que puede utilizar para clasificar cualquier documentación técnica son el usuario y el caso de uso.
Por «el usuario», me refiero a qué tipo de usuario utilizará el documento? ¿Es una guía de administrador, un tutorial o una guía de usuario? Estos niveles de conocimiento se tienen en cuenta al diseñar un documento. Una guía de administrador asume que la persona que lee el documento sabe un poco más que el lector del tutorial.
Por «caso de uso», me refiero a para qué se usa el documento. Esto puede abarcar desde documentación militar sobre cómo lanzar un misil hasta documentación para desarrolladores sobre cómo usar una API de gráficos para desarrollar un videojuego.
Si puede reducir su pregunta, es posible que pueda para brindarle más de lo que está buscando.