User manual készítése

Fórumok

Hi,

Szükségem lenne egy megoldásra, amivel a következőket tudom megtenni:

- Egyszerűen lehessen vele összerakni egy felhasználói doksik (html, kereshető, screenshot-okkal megtűzdelt)
- Mindenki ne lásson bele (pl. google bot ne, de az ügyfelek saját acc-al igen).
- A HTML-en kívül lehessen pl. pdf-be a teljes manual-t kigenerálni, ha szükséges

Kb. ennyi. Valamelyik wiki-re gondoltam első körben. Ti mit használtok erre a célra ?

Hozzászólások

Dokuwiki. Ha nem is out-of-the-box tudja amit felsoroltál, de egy-két pluginnal, egy okosabb lappal a fentieket megoldottam.

Mindenféle tapasztalat nélkül, csak mert sok helyen találkozok vele a doxygen jutott eszembe. Első körben én szerintem ide nyúlnék.

Ha nem zavar, hogy kezzel irod az XML-t, akkor a Docbookot ajanlom.

Erre a celra kivaloan hasznalhato lenne a DITA.
Ez egy xml alapu dokumentacios rendszer - tobb nagy ceg hasznalja -, eredetileg IBM talalmany.
Egyetlen bajom az volt vele, hogy ha linux alaltt csinaltam a doksit utf-8 kodolassal, akkor ageneralt pdf dokumentumban a hosszu dupla ekezetes maganhangzok helyen ? jelent meg. Ez persze nem a DITA hibaja, hanem a pdf generalo module, bovebben az adobe-e.
Ha windows alatt csinalod a szovegeket ott nincs gond.

Vannak raepulo szovegszerkesztovel megaldott rendszerek is.

LaTeX. Egyszer megirod, es ugyanazt a forrast tudod forditani html-be, pdf-be, meg meg kitudja mibe.
Lathatosagot meg nyilvan a webserveren kell mogoldani ezesetben. Gondolom ha a doc1.html-re jon request
azt atiranyitod pl egy auth.php?url=doc1.html -re, ami eldonti cookiek alapjan, hogy elkuldi-e a fajt.
De nem vagyok webhuszar, viszont itt - halistennek -sokan igen. Majd ok elmondjak, hogy mukodik ez.

---------------------------------------------------------------------------------------
Unix is simple. It just takes a genius to understand its simplicity. — Dennis Ritchie

a doksit sztem docbook-kal írd, esetleg LaTeX. Mindkettőből lehet HTML-t és PDF-et is generálni.

Az authentikációt meg megoldhatod HTTP auth-al, vagy ha ez vmiért nem kivitelezhető (pl. az userek maguktól regisztrálnak) akkor írhatsz egy minimális (mondjuk) PHP programot amivel be tud jelentkezni a felhasználó és utána tudja nézegetni a doksikat.

Dokuwiki-t használunk egyénként fejlesztői dokumentációs célokra.
Valószínűleg ez lesz a nyerő.
Nem tud esetleg valaki egy magázó fordítást hozzá ?