Zdravím, chtěl bych si nechat poradit v čem nejlépe psát el. manuály (trošku na úrovni)? Potřebuji to pro popis síťové konektivity, pc infrastruktury a obecné návody a postupy. Chtěl bych tam obrázky, popisky, poznámky atd.
Děkuji za každou radu/zkušenost
Záleží na tom, jak by ta dokumentace měla vypadat. Nejrozšířenějším formátem pro dokumentaci a de facto standardem je Docbook, což je značkovací jazyk přímo pro dokumentaci. Ten se používá i v Red Hatu a Fedoře. Nicméně je navrhnutý na tradiční dokumentaci o jednom velkém dokumentu ve stylu knížky.
Mně se líbí Mallard, který je hodně podobný Docbooku, je takovou odlehčenou verzí. Nevytváří se tam jeden dokument, ale dokumentace se skládá z množiny souborů představující kapitoly. Ty lze variabilně provázat odkazy, vytvářet strukturu atd. Dají se do něj přidávat videa z webu apod. Hodí se na dokumentaci, kde člověk hledá konkrétní řešení problému. Není pro dokumentaci, která by se měla číst jako knížka od začátku do konce. Na to se víc hodí Docbook.
Jo jo, Latex je univerzál na vše Když už jsme na tom fóru Fedory, tak dokumentace (teda ta originální, anglická[/url]) je vytvářena pomocí nástroje [url=https://fedorahosted.org/publican/]publican - výstupy má, co vím, do html, pdf a epub.
stderr napsal(a):
Jo jo, Latex je univerzál na vše
Já osobně bych LaTex na nějakou rozsáhlejší dokumentaci nepoužíval. Podle mně se to v tom musí blbě udržovat. Raději bych to psal v Docbooku. Do LaTexu se to dá vždycky předklopit. Nástroje na konverzi Docbook->LaTex existují.
Když už jsme na tom fóru Fedory, tak dokumentace (teda ta
originální,
[url=http://docs.fedoraproject.org/en-US/Fedora/18 /html/Security_Guide/chap-Security_Guide-General_P rinciples_of_Information_Security.html]anglická[/
url]) je vytvářena pomocí nástroje
[url=https://fedorahosted.org/publican/]publican[/
url] - výstupy má, co vím, do html, pdf a epub.
Publican jsou víceméně jen nástroje kolem Docbooku, které usnadňují sestavování dokumentace, publikaci atd. U rozsáhlejších projektů se to hodí, u malé dokumentace je to podle mně zbytečné.
Je to opravdu o tom, jakou to ma mit formu, kolik lidi se na tom ma podilet a jake to ma mit a vystupy. Treba tady prirucku piseme ve wiki a pak se to exportuje do PDF. Taky to funguje, i kdyz ten vystup do PDF neni idealni.
Pokud byl dotaz minen “Mam to psat v LibreOffice nebo necem jinem” pak opet je potreba si rici komu to ma smerovat. Na profi vystup manualu k cemukoli je potreba v “office like” napsat text a pak to prohnat pres DTP (Scribus). Pokud to ma byt pro sekretarku v praci, pak to klidne naflakej jen v office, pokud to ma byt spolecna prace vetsiho tymu lidi s vystupem pro vicero lidi a ma se s tim pozdeji jeste neco delat, pak by asi ten docbook nebyl od veci.
Děkuji všem za názory/rady . Ano má to být pro tým cca 3-5 lidí a výstup půjde také pro více lidi. Pravě zmiňované (LaTex a DocBook) jsem našel pomocí “strýčka” googla, a proto jsem chtěl trošku objektivnější názor od něho zkušenějšího. Zkusím se poprat s DocBookem. Ještě jednou děkuji