Tvorba dokumentace k softwaru.

Martin Hanek - UNIDATAZ s.r.o. Znojmo hanek na unidataz.cz
Čtvrtek Leden 4 09:35:18 CET 2007


Dobry den,

jsem na poli tvorby dokumentace uplnym novackem.
Mam nasledujici situaci. Piseme software do PC, ktery ma byt ve vice
jazycich a k nemu i tisknutelne manualy. Soucasna situace je takova:
- napise se software cesky
- podle nej se udela cesky manual ve Wordu (nebo podobnem)
- texty softwaru se prelozi do anglictiny
- udela se anglicky manual podle ceskeho manualu a anglicke verze softu
- pak se prelozi i do dalsich potrebnych jazyku (manual uz ne)

Nevyhody jsou jasne:
- kdyz se zmeni nejake texty v softu, manual to nepodchyti
- delat timto zpusobem manual je hrozna otrava a je to zdlouhave
- to uz vubec nemluvim o anglicke verzi
- nemame v programu vubec HELP, to by byly dalsi texty
- udrzovat aktualni vsechny texty je veliky problem
- velmi spatne se hlidaji zmeny

Jak to ovsem delat jednoduseji a efektivneji?
Pro tvorbu manualu asi pouziju DOCBOOK. Jeden zdrojak, jednoduse se daji
hlidat pres CVS zmeny, pak vygeneruju PDFko na tisk, HTML help jako
napovedu a pripadne i HTML stranky, treba jako online help.

Ovsem jak do toho skloubit i jine jazykove verze? Abych mel zdrojak
treba v cestine a lehce zjistil, co nemam anglicky a prelozil to?
A nejslozitejsi, jak zarucit, aby sedelo pouzite nazvoslovi v samotnem
programu a v manualu?

Jaky system pouzivate? Jaky system pouzivaji vetsi projekty? Letmo jsem
nahledl do OpenOfiice.org, kde pouzivaji nejake PO soubory. Netusim o co
jde.
Dekuji za tipy a pripadnou diskusi.

Martin Hanek



Další informace o konferenci Docbook