Brukervennlig publisering av dokumentasjon

Dokumentstandarder

Hva er dokumentstandarder?

XML i seg selv hjelper fint lite som et dokumentformat uten at man benytter en dokumentstandard. Med dokumentstandard tenker vi på et strukturelt regelverk for hvordan innholdet i et dokument skal bygges opp. Slike standarder uttrykkes gjennom en Document Type Defenition (DTD) eller et XML Schemas. DTD er mest utbredt innen dokumentasjonsformål.

En DTD beskriver forholdet mellom de forskjellige innholdselementene som kan forekomme i et dokument. For eksemple kan en DTD styre at man alltid må ha en tittel når man starter å skrive et nytt kapittel.

Dokumenstandarder kan deles inn i to grupper. Tilpassede standarder og bransjestandarder.

En tilpasset standard er en DTD utviklet konkret for et dokumentasjonsbehov. For eksempel vil regjerningsdokumenter ha et behov for en gitt struktur som ingen bransjestandard kan dekke.

Kjente bransjestandarder

Bransjestandarder er DTD'er utviklet for en konkret bransje, enten av bransjen selv eller interesseorganisasjoner. En bransjestandard vil ofte være mer omfattende en en tilpasset standard.

DITA

DITA ble i starten utviklet i stor grad hos IBM. I mars 2004 ble DITA "overført" til OASIS, og har siden vært viderutviklet og vedlikeholdt av "OASIS DITA Technical Committee" . I april 2005 godkjente OASIS versjon 1.0 av DITA.

DITA er en av de viktigste innovasjonene innen XML publisering den siste tiden. Hvis du benytter eller planlegger å benytte XML for publisering av teknisk dokumentasjon, kommer du til å støte på DITA før eller siden.

DITA er veldig fokusert på gjenbruk. Man vedlikeholder forskjellige emner eller "topics" som det kalles. Når man skal publisere "setter man sammen" ønskede topics for det produktet man skal lage. På denne måten kan man lage mange forskjellige produkter og publisere på flere forskjellige medier basert på samme informasjon.

Det finnes verktøy "out of the box" hvor man kan redigere DITA innhold og publisere til både HTML, HTML help, Java Help, PDF etc.

DITA gjør det mulig å gjøre kundespesifikke tilpassninger i informasjonsstrukturen (DTD) og allikevel holde seg innenfor standarden slik at eksisterende verktøy kjenner igjen endringer som er gjort.

Mer informasjon om DITA kan du få ved å ta kontakt med oss i Docstream og/eller følge disse linkene:

S1000D

S1000D er en SGML/XML standard for fremskaffelse og produksjon av teknisk dokumentasjon. Den brukes ved innskrift, vedlikehold og publisering av tekniske beskrivelser og prosedyrer for militært utstyr. Opprinnelig kommer standarden fra det militære luftfart miljøet, men har også spredd seg til hær og sjø.

S1000D blir utviklet og vedlikeholdt av "Technical Publications Specification Maintenance Group" (TPSMG), en sammenslutning med medlemmer fra mange militære organisasjoner og enheter.

Det finnes mange produkter som støtter S1000D både når det gjelder innskrift, lagring og publisering. DocWeb er en av disse. For mer informasjon om S1000D kontakt oss og/eller se linkene under:

DOCBOOK

DocBook ble en OASIS standard i 1998. Til forskjell fra DITA er DocBook mer tilpasset lineær informasjon dvs. kapitler som inneholder seksjoner som igjen inneholder subseksjoner etc. En enkelt seksjon får da ingen mening tatt ut av sammenhengen med de andre kapitlene og seksjonene.

Da DocBook har vært en standard i flere år finnes det verktøy for redigering og publisering av DocBook informasjon til flere medier og formater. Dette er noe av fordelene ved å benytte en standard DTD og ikke en kundespesifik DTD.

Docstream jobber med mange prosjekter som benytter avarter av DocBook.

Du kan finne mer informasjon om DocBook ved å ta kontakt med oss og/eller følge disse linkene: