Mi Dita, és miért van rá szükség, műszaki dokumentáció
Mi DITA és miért van rá szükség?
„A legfontosabb, hogy megértsék rabotyDITA- elv megértése, hogyan használja témák, térképek és kimeneti formátumot. Fogom magyarázni mindezt részletesen, de itt van az általános kép: tartalmat hoz létre vDITA-téma, ispolzueteDITA kártya, hogy meghatározzák, milyen témákat fog esni az egyes ellátási, majd feldolgozza ezeket a kártyákat a meghatározása kiadási formataDITAdlya létre a végeredményt. "
Sok mai fejlesztők Módszertani programok arca nagy dilemma.
A diákok egy kicsit az időt, hogy megértsék és megtanulják, hogyan kell hatékonyan használni az összetett termékek és rendszerek. Kezdeni egy racionális oktatási program, a fejlesztők kell, hogy a hallgatók magas színvonalú tanulási tartalommal szabott sajátos szerepét a hallgató, és az időben történő szállítás a felhasználónak. Ugyanakkor, a költségvetés a fejlesztés számos képzési programok csökken. Röviden, a diákok elég időt és pénzt, hogy megtanulják, mit kell tudni, és a fejlesztők kevés időt és pénzt, hogy a diákok milyen szükségességét.
Az egyik módja, ahol a fejlesztők képes megoldani ezt a dilemmát - ez hatékonyabb tartalom újrafelhasználása. Sok fejlesztők, hogy a legjobb módja annak, hogy ez a hatékonyság a specifikáció a tananyaggal (LTC), amely megjelent 1.2-es verzió elindította a Darwin Information gépelés Architecture (DITA).
„A kiadás mit?” - persze, néhány olvasó kérdez. Mielőtt válaszolnék, hadd adjak egy kis betekintést a „miért”. A teszt projekt DITA Műszaki LTC csapata IBM tanulmányozta az újrahasználat tartalom meglévő tanfolyamok. Azt találták, hogy 50% -át a tanfolyam tartalma van másolva a termék dokumentációját. Ezzel a leírásban képesek automatizálni nagy részét ilyen újrafelhasználás nem csak elkerülve a költségek és a képesség, hogy kézzel másolja be a hibát, hanem olyan hatékony módja annak, hogy szinkronizálja tartalmi frissítések a dokumentáció és képzési anyagok és mentése a fordítási költségek, anélkül, hogy egyetlen tartalom kétszer. Hát nem érdemes többet megtudni ezt?
Ebben a cikkben adok egy leírást és rövid története DITA, hogyan DITA elősegíti a hatékony és univerzális újrafelhasználása különböző célból tartalomszolgáltató és megvitatják, hogyan LTC DITA leírás összpontosít előnyeit képzés.
Miért Darwin?
Sokan nem ismerik a DITA, megkérdezte: „És itt Darwin Information gépelés Architecture”. Részeként a természetes szelekció elmélete természettudós, Charles Darwin megállapította, hogy a növények és állatok öröklik vonások a szüleiktől. Hasonlóképpen sok az elemek DITA örökölje az attribútumokat szülő elem. Art tükrözi a természet.
DITA széles körben használják a világon a műszaki dokumentáció cégek, mint a Cisco, az IBM (természetesen), a Nokia és az Oracle. De a bevezetése DITA jellemző nem csak a magas technológia. Boeing és a US Department of Health veteránok már lépett DITA bizottságok és én személyesen segített költözni DITA a termék dokumentációjában ITT Fluid Technologies (a gyártó a szivattyúk és szelepek). DITA végrehajtása szakképzés elmaradt a világon, amely azonban nem meglepő, hiszen a kezdeti hangsúlyt DITA műszaki kiadványok inkább tananyag.
A legfontosabb, hogy megértsék a működési elve DITA - annak megértése, hogy miként használja témák, térképek és kimeneti formátumot. Én akkor fejtse ki részletesen, de itt van az általános kép: tartalmat hoz létre témák DITA használja DITA-térkép, hogy meghatározzák, milyen témák beleesik az egyes ellátási, majd feldolgozza ezeket a kártyákat a meghatározása DITA kimeneti formátumot létrehozni a végeredményt.
DITA-tetejét egy bizonyos szerkezetű. Ez úgy történik közötti összhang Topeka kifejlesztett különböző emberek. Például a témához kapcsolódó feladat magában a felsorolás sorrendjében:
- header;
- előfeltételt (mit kell tudni, hogy vagy nem teljesítik a hallgató, hogy végezze el a feladatot);
- feladatok végrehajtása;
- A várt eredmény a feladat;
- Utáni cikkek (amit a tanuló kell tenni, miután a feladat).
Módosíthatja ezt a struktúrát, ahogy tetszik. Például akkor szükséges, hogy minden probléma volt neve, további információk, akciók és várt eredmények, de hagyja a befogadás előfeltételek és a poszt-kellékei fejlesztők minden egyes témában.
alapértelmezett DITA nyújt három fő téma, mindegyiknek megvan a maga struktúrája és alapértelmezett szabályokat. Használhatja a koncepció téma felülvizsgálati és kontextuális információt, amely a téma, a feladat, hogy információt szerezzenek konkrét feladatokat és a témához lábjegyzet további információkat, mint például a rendszer előírásainak, cikkszámok, és a dokumentum szintaxis. DITA 1.0, 1.1 is rendelkezik egy univerzális téma, DITA fejlesztők képes alkalmazkodni, hogy illeszkedjen az Ön igényeinek. DITA 1.2-más típusú alapértelmezett témák, amelyek közül néhány része a specifikációk LTC. Fogom leírni őket később a szakasz „Mi a leírás DITA LTC».
Ezen a ponton, azt gondolhatja, hogy „Ó, ez az egész arról DITA tűnik, elég bonyolult.” Az igazság az, hogy van néhány nagyon nehéz aspektusait DITA, de az alapvető mechanika fejlesztési témák DITA viszonylag egyszerű. Az 1. ábra a kód egyszerű DITA téma feladat.
Hadd hívjam fel a figyelmet, hogy egy pár több funkciót az alábbi ábrák.
Másodszor, ahogy ezek a példák képet tartalmaznak, akkor is a DITA téma-Gyakorlatilag bármilyen multimédiás -kontent: audio, flash video, stb Mivel a HTML, itt be linkeket az internetes tartalom. A legfontosabb, amit érdemes megjegyezni - a végleges változat a formátumot (saját tapasztalat azt mondják, hogy a GIF-animáció nem túl jól mozog nyomtatott formában).
Ahhoz, hogy a célba juttatott egy adott termék, vagy a célközönség, használja DITA-kártyát. DITA-kártya van egy lista a mutató egy sor konkrét témák, melyik témákat kell venni a szállítás. A kártyát is, hogy milyen sorrendben és hierarchiája témák és biztosítja a navigációt, például a tartalomjegyzék és kereszthivatkozások között Topeka részeként a végleges változat.
Maps lehet létrehozni bármely szakaszában dolgozó DITA. Néhány gyártó a kártya, mint a tervezés és nyomkövető eszköz létrehozása előtt a témát, és mások térképek készítését követően fejlesztési témák. Mindenesetre, és a kész kártya és a témakörök létrehozásához szükséges a végső szállítás.
Egy valós környezetben DITA-témák sok a kártya lesz sokkal magasabb, mint a példa mutatja. Jellemzően több mint fele témák különböző kártyákat.
Emlékezzünk vissza, hogy DITA 1.2 specifikáció határozza meg a téma DITA mint „című információs egység, amely értelmezhető elszigetelten egyéb egységek és használják a különféle helyzetekben.” Térképek segítenek megérteni, hogy miért olyan fontos, hogy a tartalom semleges kontextusban minden lehetséges témát, ahol ez lehetséges. Például ha használt egy csomó „Korábban megtanultuk ...” vagy „Az ABC a témában ...” így állapítható meg egy kapcsolatot a két téma. De ha egy másik ellátási hiányzik, vagy van olyan téma, más sorrendben, akkor küld embereket a rossz vagy nem létező egyáltalán tartalmat. Ha még mindig kell használni a szöveges link a témában, vannak olyan módon kell csinálni, de ez nem lényeges, hogy ezt a cikket.
Annak ellenére, hogy a pont a 3. ábrára, nem szükséges, hogy tartalmazza a téma a térképen. Szálak és DITA kártya aktívan használja a metaadatok feldolgozásához adott feltételek (szűrés) Az adatok lehetővé teszik az eltérő kiviteli alakjai olyan téma, amikor kártya feldolgozás. Tegyük fel, hogy van három téma az „On (mi mást)”, amely teljesen azonos tartalommal, kivéve a bevezető mondat. Mi is létrehozhatunk egy témára „On (mi mást)”, amellyel a három különböző változatai bevezető mondatok, majd alkalmazza a metaadat, amely jelzi a kifejezések mindegyikének megfelelő termék. Kezelés metaadatokat térkép meghatározza, hogy a mondatok szerepelnie kell a szövegben az egyes esetekben.
Térképek mutathat nemcsak a téma, hanem a többi kártya. Ezt fel lehet használni, például, hogy hozzon létre egy térképet minden lecke során; majd egy másik kártyát, amely jelzi osztályok tartalmazzák során és milyen sorrendben. Csakúgy, mint a téma, ha map valami változik, a változások minden térképeket, hogy hivatkoznak rá.
Fel kell ismerni, hogy a 3. ábra mutatja, egy nagyon egyszerű példát; Azt hallottam, hogy az IBM jelenleg támogatja a több mint egymillió DITA-téma, és ki tudja, hány kártyát. De még ez a példa illusztrálja a gazdag funkciók és a sokoldalúság DITA. És a kimeneti formátumot, amelyet alább, tovább bővíti ezeket a lehetőségeket.
Mivel DITA használja szemantikai címkézés helyett formázó, ez vezérli a kimeneti formátum fog kinézni szállítás. Sok fejlesztő módosítani DITA kimeneti formátumot előírt megfelelő mintákat, korábban kifejlesztett Microsoft Word vagy Adobe FrameMaker. Módosítása a PDF formátum különösen trükkös, de sok eszköz segít egyszerűsíteni a munkát.
És mi a helyzet a tartalomkezelő rendszer?
felhasználásának kérdése tartalomkezelő rendszerek gyakran emelt (CMS) együttműködve DITA. CMS biztosítja a különböző hasznos funkciók, mint például a teljesítmény ellenőrzése és kezelése felülvizsgálat DITA-Topeka, térképek és kimeneti formátumot. Bár sok DITA szerszámok részesülhet együttműködve CMS, jelenléte nem szükséges. CMS költséges lehet végrehajtani, így alaposan elemezzék speciális igényeinek.
Értékelje a hihetetlen sokoldalúság minden DITA-topic. Térképek olyan témák, hogy meghatározza a rend és hierarchia a téma, az csak releváns az adott terméket, a célközönség és a tartalom, és végül létre egy ellátási tartalmazó ebben a témában a különböző kimeneti formátumot. Ha valami változik a téma, ez tükröződni fog a végleges változat.
A cikk elején említettem DITA előírás tananyaggal (LTC), és hogyan használja az IBM, hogy automatizálják a újrafelhasználásának tartalom, szinkronizálja a dokumentációt a termékek és a megtakarítások fordításban.
Specifikáció - olyan funkció, amely lehetővé teszi, hogy a fejlesztők DITA még nagyobb rugalmasságot. Három alapvető típusa rendelkezésre álló témák DITA (fogalmakat, célkitűzéseket és lábjegyzetek), jól működik a műszaki kiadványok, de nem mindig kényelmes a kínálat tananyaggal. Ezen esetekben szükség speciális típusú témák célja, hogy értékelje a tanulás és gyűjtő, valamint speciális címkék létrehozott tananyag.
A Bizottság megállapította, leírások a legjobb módszertani fejlesztések, amelyek használják a képzés az ipar, de a leírás nem összpontosítani egy adott képzési modell.
LTC Műszaki kínál egy hatalmas különféle oktatási tartalom fejlesztők. Ez magában foglalja a típusú témák, melyet kifejezetten a képzési tervek, felmérések, tájékoztató anyagok, összefoglalók, értékelések; valamint számos speciális címkéket tervezni, például az oktató jegyzetek, értékelő elemek (zárt és nyitott kérdések, kérdések a választás egyetlen lehetőség, és így tovább). Leírás is támogatja speciális képzési metaadatokat (például a képzés és a nehézségi szint).
Természete miatt a DITA öröklés, akkor is, ha más fejlesztők létre DITA felsők van LTC specifikációk, akkor is használhatja a téma LTC és LTC együtt. Például létrehozhat egy térképet a leckét, ami azzal kezdődik, hogy vizsgálják felül a LTC, majd nézze meg több, nem LTC témájú termék dokumentációját, majd befejezi a összefoglalását és értékelését az LTS. Az alapvető fogalmak DITA, amit ebben a cikkben ismertetett alkalmazni LTC Műszaki; Például meg lehet építeni órák vagy teljes tanfolyamok segítségével DITA-térkép, és ezáltal a végső átadási használatával kimeneti formátumot.
Tehát, mire van szükségünk, és DITA leírás LTC? Tegyük fel, hogy Ön dolgozik nagy mennyiségű tananyag, hogy lemásolja a tartalmat különböző forrásokból származó vagy a munka nagy csapat, akiknek a legjobb tartalmi összhang. Ebben az esetben a DITA leírásban és LTC lehet a tökéletes megoldás arra a problémára, hogy a tanulók kellő időt és pénzt, hogy tanulmányozza, és ha - sőt, számukra minden szükséges. Ha a megjelenés Műszaki LTC vezet az a tény, hogy a DITA 1.2 tanulás elterjedt a fejlesztők leggyorsabban DITA 1.0 és 1.1 elterjedése a műszaki dokumentációban a világ, akkor valószínű, hogy a főnök hamarosan érdekelt, hanem adja-e a szervezet DITA.
Megjelenése óta DITA számos szervezet segítségével DITA műszaki dokumentáció, hogy megértsük, hogyan szempontjából is előnyös az időt és pénzt takarít, míg ugyanabban az időben minőségének javítása és a sokoldalúság. Azt is megállapították, más előnyei a DITA, mint például a növekvő száma az együttműködés lehetőségeit a fejlesztés környezetre.
Bevezetésével Műszaki LTC ezeket az előnyöket elérhetővé vált és a képzés a fejlesztők. Ezen túlmenően, a specifikáció közötti együttműködés lehetőségeinek a csapat részt vesz a képzésben és a dokumentációt. Megértem, hogy az ilyen csapatok rendszerint külön-külön, ez a technológia nem fedezi az összes megközelítések a tartalmat, de még annak a lehetőségét, DITA üzleti nagyon vonzó. Ez könnyen telepíthető a DITA? Nem. függetlenül attól, hogy fizeti ki az idők folyamán? Ha mindent jól megtervezni és végrehajtani, talán.
Hivatkozások és források