Strukturert dokumentasjon handler om hvordan informasjon «tagges», organiseres og presenteres på en systematisk og konsistent måte for å sikre gjenbruk, enkel oppdatering og interoperabilitet. Her er en utdyping av noen av de vanligste standardene vi jobber med:
XML og XHTML
XML (Extensible Markup Language) er et såkalt markeringssråk for å strukturere data i en lesbar og maskinvennlig form. Det gir mulighet til å definere egne tagger og datatyper, noe som gjør det ideelt for å representere dokumenter som krever strukturert informasjon. XML brukes ofte for lagring og utveksling av data mellom forskjellige systemer, fordi det er både plattformuavhengig og fleksibelt.
XHTML (Extensible Hypertext Markup Language) er en strengere versjon av HTML basert på XML. XHTML krever at dokumentene følger strengere regler for å være mer kompatible med XML-verktøy og nettlesere. Denne strukturen gjør XHTML lettere å tolke av både mennesker og maskiner.
CSS og XSLT
CSS (Cascading Style Sheets) brukes til å formatere og style HTML- og XML-dokumenter. CSS skiller presentasjon (utseende) fra innhold (strukturert informasjon), noe som muliggjør enkle endringer av utseendet på et nettsted eller et dokument uten å måtte endre strukturen.
XSLT (Extensible Stylesheet Language Transformations) er et kraftig verktøy for å transformere XML-dokumenter til andre formater, for eksempel HTML, PDF eller et annet XML-format. XSLT gjør det mulig å bruke én kilde (XML-dokument) og presentere den på forskjellige måter avhengig av bruksområdet.
DITA og DITA CMS
DITA (Darwin Information Typing Architecture) er en XML-basert standard for teknisk dokumentasjon, utviklet for å gi gjenbruk og modularitet i dokumenter. Det er spesielt designet for å håndtere store mengder teknisk innhold ved å dele det opp i små biter av informasjon (emner), som kan settes sammen på forskjellige måter. Dette gjør det enklere å gjenbruke, oppdatere og tilpasse dokumentasjonen.
DITA CMS (Content Management System) er et programvare system som håndterer DITA-baserte dokumenter. Slike CMS-løsninger gjør det mulig å organisere, lagre, og publisere DITA-emner effektivt, samtidig som det gir kontroll over versjoner, revisjoner og samarbeid mellom ulike brukere.
S1000D
S1000D er en internasjonal spesifikasjon for teknisk dokumentasjon, hovedsakelig brukt innen forsvarsindustrien og luftfart. Denne standarden definerer strukturerte dokumenter ved hjelp av XML for å sikre konsistent format, interoperabilitet og gjenbruk av innhold på tvers av ulike systemer og plattformer. S1000D er designet for å dekke et bredt spekter av teknisk dokumentasjon, fra operasjonsmanualer til vedlikeholdsinstruksjoner. Det er spesielt nyttig for komplekse produkter som krever grundig og oppdatert dokumentasjon, ettersom innholdet kan brytes ned i små, modulære informasjonssett kalt «Data Modules» som enkelt kan oppdateres og distribueres på tvers av flere plattformer og systemer.
MIL-STD-40051
MIL-STD-40051 er en amerikansk militær standard som gir retningslinjer for utarbeidelse av tekniske manualer for utstyr og systemer. Den dekker både elektroniske og papirbaserte formater, og sikrer konsistens og nøyaktighet i teknisk dokumentasjon. Standarden beskriver krav til innholdsstruktur, formatering og illustrasjoner for å forbedre brukervennlighet og støtte vedlikehold av utstyr. Den legger vekt på modularitet, slik at manualene kan deles opp i lett oppdaterbare seksjoner.
Oppsummering
Disse strukturene og verktøyene for dokumentasjon gir ulike nivåer av fleksibilitet og kontroll over innhold, design og interoperabilitet. De brukes i ulike bransjer og situasjoner, alt fra webutvikling til store tekniske dokumentasjonsprosjekter. De sikrer at dokumentasjon er lett å forstå, vedlikeholde og gjenbruke på tvers av ulike systemer.