Hispanopedia WikiTechnical documentation is a generic term for the classes of information created to describe (in technical language) the use, functionality, or architecture of a product, system, or service.
Classes of technical documentation
Classes of technical documentation may include:
- patents
- specifications of item or of components/materials
- data sheets of item or of components/materials
- test methods
- manufacturing standards
- system requirements
- system architecture
- system design documents and data including those necessary for the system development, testing, manufacturing, operation and maintenance
Standardizing technical documentation
Historically, most classes of technical documentation lacked universal conformity (standards) for format, content and structure. Standards are being developed to redress this through bodies such as the International Organization for Standardization(ISO), which has published standards relating to rules for preparation of user guides, manuals, product specifications, etc. for technical product documentation. These standards are covered by ICS 01.110.[1] Technical product documentation not covered by ICS 01.110 are listed in the subsection below.
Discipline-specific
EU Medical Device Regulation
A technical documentation is also required for medical devices following EU medical device regulation. Annex II, Technical documentation, and Annex III, Technical documentation on post-market surveillance, of the regulation describe the content of a technical documentation for a medical device. This includes e.g. information on the device specification, labelling and instructions, design and manufacture, safety and performance requirements, risk management, and the validatain and verfification of the device, including the clinical evaluation; and also information from postmarketing surveillance.
Formats for source data
Documentation architecture and typing
Algunos sistemas de documentación se ocupan de los tipos o formatos generales de documentación que constituyen un conjunto de documentos, así como (o en lugar de) de cómo se produce, publica o formatea la documentación.
Por ejemplo, el marco Diátaxis (que se utiliza principalmente en el campo de la documentación de software [ 8 ] ) propone cuatro formas de documentación distintas, que corresponden a cuatro necesidades diferentes del usuario: tutoriales , guías prácticas , referencias y explicaciones . [ 9 ] Por el contrario, DITA afirma cinco "tipos de temas" diferentes: Tarea , Concepto , Referencia , Entrada de glosario y Solución de problemas , mientras que el sistema de Documentación Modular de Red Hat utiliza tres "módulos": Concepto , Procedimiento y Referencia . [ 10 ]
Véase también
Citas
- ↑ "01.110: Documentación técnica del producto" . Organización Internacional de Normalización . Consultado el 10 de junio de 2009 .
- ↑ "ISO 15787:2001 Documentación técnica del producto - Piezas ferrosas tratadas térmicamente - Presentación e indicaciones" . Organización Internacional de Normalización . Consultado el 10 de junio de 2009 .
- ↑ "ISO 3098-0:1997 Documentación técnica del producto - Rotulación - Parte 0: Requisitos generales" . Organización Internacional de Normalización . Consultado el 10 de junio de 2009 .
- ↑ "ISO 10209-1:1992 Documentación técnica de productos - Vocabulario - Parte 1: Términos relacionados con dibujos técnicos: generalidades y tipos de dibujos" . Organización Internacional de Normalización . Consultado el 10 de junio de 2009 .
- ↑ "ISO 2162-1:1993 Documentación técnica de productos - Muelles - Parte 1: Representación simplificada" . Organización Internacional de Normalización . Consultado el 10 de junio de 2009 .
- ↑ "ISO 5457:1999 Documentación técnica del producto - Tamaños y disposición de las hojas de dibujo" . Organización Internacional de Normalización . Consultado el 10 de junio de 2009 .
- ↑ ISO6433 Documentación técnica del producto. Referencias de las partes , BSI British Standards, doi : 10.3403/30203812 , hdl : 20.500.12259/288139 , consultado el 16 de diciembre de 2020.
- ↑ "Lista parcial de conjuntos de documentación de Diátaxis" . Consultado el 10 de abril de 2021 .
- ↑ "Esquema de los formularios de documentación de Diátaxis" . Archivado del original el 16 de abril de 2021. Recuperado el 10 de abril de 2021 .
- ↑ "Términos y definiciones de la documentación modular de Red Hat" . Consultado el 11 de abril de 2021 .
- Documentos
- Comunicación técnica