Teknisk dokumentation

Teknisk dokumentation är en generisk term för de klasser av information som skapats för att beskriva (på fackspråk ) användningen, funktionen eller arkitekturen hos en produkt, ett system eller en tjänst.

Klasser av teknisk dokumentation

Klasser av teknisk dokumentation kan inkludera:

Standardisering av teknisk dokumentation

Historiskt sett saknade de flesta klasser av teknisk dokumentation universell överensstämmelse (standarder) för format, innehåll och struktur. Standarder utvecklas för att komma till rätta med detta genom organ som International Organization for Standardization (ISO), som har publicerat standarder som rör regler för utarbetande av användarguider, manualer, produktspecifikationer etc. för teknisk produktdokumentation. Dessa standarder omfattas av ICS 01.110. Teknisk produktdokumentation som inte täcks av ICS 01.110 listas i underavsnittet nedan.

Disciplinspecifik

EU:s förordning om medicintekniska produkter

En teknisk dokumentation krävs också för medicintekniska produkter enligt EU:s medicintekniska förordning . Bilaga II, Teknisk dokumentation, och bilaga III, Teknisk dokumentation om övervakning efter utsläppande på marknaden, till förordningen beskriver innehållet i en teknisk dokumentation för en medicinteknisk produkt . Detta inkluderar t.ex. information om produktens specifikation, märkning och instruktioner, design och tillverkning, säkerhets- och prestandakrav, riskhantering och validering och verifiering av produkten, inklusive den kliniska utvärderingen; och även information från övervakning efter marknadsföring .

Format för källdata

Dokumentationsarkitektur och maskinskrivning

Vissa dokumentationssystem handlar om de övergripande typer eller former av dokumentation som utgör en dokumentationsuppsättning, såväl som (eller snarare än) hur dokumentationen produceras, publiceras eller formateras.

Till exempel innehåller ramverket Diátaxis (som mest används inom området mjukvarudokumentation) fyra distinkta dokumentationsformer, som motsvarar fyra olika användarbehov: handledningar , hur man gör-guider , referens och förklaring . Däremot hävdar DITA fem olika "ämnestyper": Uppgift , Koncept , Referens , Ordlista och Felsökning , medan RedHats modulära dokumentationssystem använder tre "moduler": Koncept , Procedur och Referens .

Se även

Citat