La documentació tècnica és un terme genèric per a les classes d'informació creades per descriure (en llenguatge tècnic) l'ús, la funcionalitat o l'arquitectura d'un producte, sistema o servei.
Classes de documentació tècnica Les classes de documentació tècnica poden incloure: Insereix un paràgraf
patents especificacions de l'article o dels components/materials fitxes tècniques de l'article o dels components/materials mètodes de prova estàndards de fabricació requisits del sistema arquitectura del sistema documents i dades de disseny del sistema, inclosos els necessaris per al desenvolupament, les proves, la fabricació, el funcionament i el manteniment del sistema
Estandardització de la documentació tècnica Històricament, la majoria de classes de documentació tècnica mancaven de conformitat universal (estàndards) pel que fa al format, el contingut i l'estructura. S'estan desenvolupant normes per solucionar això a través d'organismes com l'Organització Internacional per a l'Estandardització (ISO), que ha publicat normes relatives a les normes de preparació de guies d'usuari, manuals, especificacions de productes, etc. per a la documentació tècnica de productes. Aquests estàndards estan coberts per l'ICS 01.110. La documentació tècnica del producte no coberta per l'ICS 01.110 s'enumera a la subsecció següent.
Específic de la disciplina Insereix un paràgraf
ISO 15787 ISO 3098 ISO 10209 ISO 2162 ISO 5457 ISO 6433
Reglament de dispositius mèdics de la UE També es requereix una documentació tècnica per als dispositius mèdics d'acord amb el reglament de dispositius mèdics de la UE. L'annex II, Documentació tècnica, i l'annex III, Documentació tècnica sobre vigilància posterior a la comercialització, del reglament descriuen el contingut d'una documentació tècnica per a un producte sanitari. Això inclou, per exemple, informació sobre les especificacions del dispositiu, l'etiquetatge i les instruccions, el disseny i la fabricació, els requisits de seguretat i rendiment, la gestió de riscos i la validació i verificació del dispositiu, inclosa l'avaluació clínica; i també informació de la vigilància postcomercialització.
Formats per a les dades d'origen Arquitectura de tipificació d'informació de Darwin (DITA) DocBook S1000D Text reestructurat
Arquitectura i mecanografia de la documentació Alguns sistemes de documentació es preocupen pels tipus o formes generals de documentació que constitueixen un conjunt de documentació, així com (o més que no pas) de com es produeix, publica o formata la documentació.
Per exemple, el marc de treball Diátaxis (que s'utilitza principalment en el camp de la documentació de programari) postula quatre formes de documentació diferents, que corresponen a quatre necessitats d'usuari diferents: tutorials, guies pràctiques, referència i explicació. En canvi, DITA afirma cinc "tipus de temes" diferents: Tasca, Concepte, Referència, Entrada de glossari i Resolució de problemes, mentre que el sistema de documentació modular de RedHat utilitza tres "mòduls": Concepte, Procediment i Referència.
Referències
Categoria:Documentació TemplateData Categoria:Estàndards