Hello Kern, in message <[EMAIL PROTECTED]> you wrote: > > My idea was to create the following from the current *giant* Bacula manual: > > - An Installation manual > - A Tutorial > - A Configuration manual (how to setup a few standard > configurations). > - A Deployment manual (tips, tricks, case studies, FAQ, > problem resolution, performance, security, ...) > - A Reference Manual (description of all directives) > > This is clearly open to discussion. The ones that I am pretty sure about the > Installation manual, the Tutorial, and the Reference manual.
Did you ever consider to put this stuff in a wiki? We have been using one (TWiki, to be precise) for our documentation for 3 year, and we are *happy* with this. It allows easy changing and fixing and adding new stuff by everybody who is willing to contribute with really minimal effort which IMHO is the biggest advantage - if I find a typo and can fix it immediately onlyne I will do this - if I have to prepare a patch and send an email or so I may find it's not worth the effort. Another big advantage is that you have all the full auto-linking capabilities of a wiki, which makes the documentation easy to use in an interactive (web) environment. For publishing (creating a linear, printable form of the documentation) we use a extension (WebOrder) which defines which wiki pages to select for a specific document, and in which order to present these - i. e. you can start just collecting material in independent pages (probably with links from and into other pages), and later select if and where to put this in the printed version. This can also be used to generate different versions of documetnation by just selecting different sets of pages ... If you're interested, please see: o http://www.denx.de/wiki/DULG/Manual - normal online (web) presentation o http://www.denx.de/wiki/publish/DULG/DULG-tqm8xxl.html http://www.denx.de/wiki/publish/DULG/DULG-tqm8xxl.pdf - published version as a single HTMP or PDF file o http://www.denx.de/wiki/DULG/WebOrder - "WebOrder" page which selects and orders the wiki pages into a publishable linear version (this is also responsible for creation of section numbers, TOC, etc.) [There is a lot more in this stuff - for example, all examples given in our documentation are included from log files which we get by running our regression tests - i. e. when there is a new version of the code, we just re-run the regression tests, whih generates a new set of log files, and by just copying the log files to our web server we have a new version of the documentation where every example text matches *exactly* the new version of the software.] Feel free to contact me if you have questions - TWiki itself is free software, and all our extensions are available under GPL, too. Best regards, Wolfgang Denk -- Software Engineering: Embedded and Realtime Systems, Embedded Linux Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: [EMAIL PROTECTED] "There are three principal ways to lose money: wine, women, and engi- neers. While the first two are more pleasant, the third is by far the more certain." - Baron Rothschild, ca. 1800 ------------------------------------------------------- This SF.net email is sponsored by: Splunk Inc. Do you grep through log files for problems? Stop! Download the new AJAX search engine that makes searching your log files as easy as surfing the web. DOWNLOAD SPLUNK! http://ads.osdn.com/?ad_idv37&alloc_id865&op=click _______________________________________________ Bacula-users mailing list Bacula-users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/bacula-users
