Dotaz: Jaky format pro dokumentaci

[Trained.Monkey]

Zdar,

resim problem v cem psat referencni a uzivatelskou dokumentaci k programu. Moc se v tom nevyznam, za radu budu vdecny.

Mam nasledujici pozadavky:

• jednoduchy format, neco na zpusob wiki
• WYSIWYG editor, musi zvladnout image & copy paste
• vystup do PDF
• vystup do ruznych wiki formatu
• zdrojak musi byt primo zobrazitelny web browserem jako dokument(docbook+xslt, nebo parser na bazi javascriptu)
• tooly v jave.

Nejvic toho asi splnuje docbook, ale XSLT fakt nemusim. LaTeX je jeste horsi. V cem pisete dokumentaci vy?

Odpovědi

[l4m4]

Když nepíši přímo v TeXu, tj. když potřebuji rozumný výstup do netiskových formátů, tak v DocBooku. Nemám ovšem požadavky typu WYSIWYG editoru (naopak požaduji editovatelnost čehokoli ve vimu), jednoduchého formátu (to DocBook tedy není), přímého zobrazení v browseru (k čemu to je? navíc to nejspíš vyžaduje organizaci zdrojáků typu jeden velký bordel) výstup do Wiki formátu (základní fíčura Wiki je editovatelnost, takže požadavek podle mne nemá smysl bez požadavku na přenos úprav zpět), ani tooly v Javě (ta mi na počítač nesmí). Ale ten výstup do PDF to umí ;)

[pht]

Já si vystačím s POD (pro perl), případně s LyXem (což je WYSIWYM, nikoliv WYSIWYG editor :), který primárně exportuje do LaTeXu nebo Open Document a z těch už pak uděláte cokoliv.

[Trained.Monkey]

Probral jsem si to v makovici, a budu psat primo HTML. H1 az H4 mi prijdou dostatecne a odkazy si muzu delat sam.

[Kill_Bill]

Vot eto tvoje delo... Ale pro veci jako User/Reference/aj. Manual je nejlepsi format pdf s dobre udelanymi zalozkami.