Diétázik a DITA Beszédem a tekom éves konferencián 2018; ARAKANGA GmbH

A 2018. november 13. és 15. között Stuttgartban megrendezésre kerülő tekom éves konferencián szakember előadást tartok. Pontosabban: november 15-én (Csütörtök), első dolog reggel 8: 45-kor a C4.2 szobában.

beszédem

Érdekli a könnyű DITA és mit tud vele kezdeni? Akkor remélem, hogy találkozunk!

A konferencia anyagának szövege a következő:

A DITA diétázik - csatlakozzon hozzánk!

Szeretnék bemutatni egy koncepciót a könnyű DITA-ra épülő tartalomkezelő rendszer felépítésére - olcsó eszközök segítségével. Ehhez a következő pontokra térek ki:

  • Mi a könnyű DITA?
  • Melyek a könnyű DITA előnyei és korlátai?
  • Összeállíthat-e egy rugalmas szerkesztői környezetet a szokásos eszközökből, ahelyett, hogy monolit CMS-re kellene támaszkodnia?

1. kiindulópont: piaci trendek

A műszaki dokumentáció és a szerkesztői környezet területén két ellentétes tendencia figyelhető meg:

Egyrészt a szabványok az idő múlásával egyre összetettebbek, pl. B. DITA. Ez az 1.0-s verzió kiadásakor csaknem 200 elemről nőtt az 1.3-as verzió több mint 600 elemére. Másrészt mindig vannak ellenmozgások. Mint 20 évvel ezelőtt, amikor a rendkívül összetett SGML-t tovább fejlesztették sokkal egyszerűbb XML-vé.

Ugyanez a fejlődés zajlik a DITA-nál is, ahol az egyszerűsítés vágya az új könnyű DITA szabványt eredményezte. Ez már alig kevesebb, mint 50 elemet tartalmaz, és teljesen új felhasználói csoportokat nyit meg, további formátumokként HTML és Markdown.

A markdown és más úgynevezett "könnyű jelölés" nyelvek egy másik trend, különösen a szoftverdokumentációban, amelyek jelentősen csökkentik a jó dokumentáció készítésének akadályait.

Mi a könnyű DITA?

2018 áprilisában elfogadták a Lightweight DITA első, 1.0 verzióját. A könnyű DITA fő tulajdonságai a következők:

  • Csak 48 elem maradt (a DITA 1.3-mal több mint 600 helyett)
  • 3 adatformátum, az XML (= XDITA) mellett ma már HTML (= HDITA) és Markdown (= MDITA) is létezik
  • Új multimédiás elemek
  • A szakosodás továbbra is lehetséges, mint a DITA-ban
  • Mégis DITA

A nagyszerű leegyszerűsítés természetesen azt jelenti, hogy a könnyű DITA lehetőségei korlátozottabbak, mint a DITA. Például nincsenek semmiféle információk és szemantikai formázás. Összességében a könnyű DITA minden bizonnyal kevésbé alkalmas bonyolultabb követelményekre.

Az új formátumok és a jelentős egyszerűsítés teljesen új lehetőségeket nyit meg. A könnyű DITA képes összekapcsolni a „nagy” és összetett (és drága) tartalomkezelő rendszerek világát a teljes DITA támogatással a sokkal egyszerűbb tartalomalkotás és -terjesztés világával a szoftvertermékek online segítségének területén.

2. kiindulópont: probléma meghatározása a vállalatnál

Képzelje el, hogy Ön felel egy globális internetes vállalat termékterületének dokumentálásáért. Kis csapatod szétszórtan szerte a világon, korlátozott pénzügyi és időbeli erőforrásokkal rendelkezik. Az elmúlt években számos akvizíció a folyamatok és eszközök színes portfólióját eredményezte a létrehozáshoz és a publikáláshoz. Az ügyfél szempontjából pedig nagyon eltérő dokumentáció létezik, amely a különböző URL-ek alatt található.

Az Ön feladata most ennek megszilárdítása. Mindenkinek megfelelő megoldásra gondol. A követelmények a következők:

  • Lehetségesnek kell lennie a globális együttműködésnek, lehetőleg webalapúnak.
  • A megoldásnak rugalmasnak kell lennie, függetlenül az operációs rendszertől és a böngészőtől.
  • A megoldást az adott helyzethez kell igazítani, de a jövőben alkalmazkodónak és bővíthetőnek kell lennie.
  • Olcsó és széles körben használt eszközökkel szeretne dolgozni, amelyek viszonylag kevés erőfeszítéssel testreszabhatók.
  • A szabványokat úgy kívánja használni, hogy a jövőben ne kelljen bizonyos saját szoftverekre támaszkodnia. Ez megkönnyíti az adatok cseréjét a különböző eszközök között.

Volt egy ötletem.

Ötlet: Készítse el saját környezetét a könnyű DITA alapján!

A követelményeknek és az új, izgalmas, könnyű DITA szabványnak köszönhetően mostantól lehetőség nyílik szerkesztői környezet számára egy "architektúra" megtervezésére. A fájlok mentésének legalább egy módjára, szerkesztőre és publikációs környezetre van szükség:

És más feladatokhoz sincs kötve egy adott gyártóval. Az LwDITA tartalma könnyen exportálható, könnyen konvertálható, könnyen felhasználható stb.:

  • Áttekintés: A tartalomtárak eszközei felhasználhatók a korrekciós futtatásokhoz. Vagy létrehozhat PDF dokumentumokat vagy szerkeszthető formátumokat a forrásfájlokból.
  • Fordítás: Minden elterjedt fordítási memória rendszer képes XML, HTML vagy szöveges formátumban, például Markdown fájlokat feldolgozni.
  • terminológia
  • Konverziók
  • Stb.

Hagyj megjegyzést a válasz törlése

Megjegyzés írásához be kell jelentkeznie.