Tehniline dokumentatsioon

Mai multe ca aceasta

Blogi

după Karis Niisuke

Eluolu ja kultuur kaheksakümnendatel

după Marie-Helena Rajatamm

Tehnoloogia

după Sirli Jaaska

Pani

după Villem Erik Luks

Tehniline dokumentatsioon

Veebistandardid

Suletud standard

selle puhul on spetsifikatsioon väljatöötatud mõne firma poolt ja ei ole kolmandale osapoolele avalik. Enamasti käib selle kasutamine litsensi alusel

Avatud standard

avalikuks kasutamiseks kättesaadavad riist- ja tarkvarastandardid, mille dokumentatsioon on vabalt kõigile kättesaadav, järgitav ja kasutatav

Veebilehe toimetamise juures püütakse tagada W3C (ingl The World Wide Web Consortium ) poolt väljatöötatud veebistandarditele vastavus

Tuntumate veebitehnoloogiate hulka kuulavad näiteks XHTML, HTML, CSS, Javascript, PHP, MySQL ja Adobe Flash.

Võimaldavad veebilehtedel toimida üheselt erinevates veebilehitsejates

DITA on akronüüm terminile Darwin Information Typing Architecture

Lühitutvustus

DITA on XML keelel põhinev andmemudel

See on avatud standard, mida haldab globaalne organisatsioon nimega OASIS

Iseloomulikud jooned

DITA teemad ja kaardid on XML failid

neid saab muuta suvalise tekstitoimetiga

DITA teemad kui kaardid võivad sisaldada erinevaid metaandmeid

indeksi terminid, autor, toote versioon, ja nii edasi

Teemasid saab kasutada erinevates dokumentides ja kontekstides

Samuti saab kasutada ka teemade fragmente

DITA kaardid on teemade kogumikud

Iga kaart defineerib teemade struktuuri ja järjekorra

DITA sisu koosneb teemadest, mitte dokumentidest

Iga teema kirjeldab ühte infokogumit

Docbook

Lühikirjeldus

Docbook on semantiline märkimis keel tehnilise dokumentatsiooni jaoks

S1000D

Subtopic