Hi, Have you considered using Doxygen ( http://www.stack.nl/~dimitri/doxygen/ )? I've found this to be a fantastic tool, both for documenting code, and other things. Doxygen makes it a breeze to link separate sections/pages, has alot of auto-crossreferencing capabilities etc. You could eg. in the Developers Guide place links directly to the source-docs, so lookups would be greatly improved time-wise. It can auto-generate documentation in html, pdf, latex and more.
-- Christopher On Wed, 6 Feb 2008 19:16:19 +0100, Kern Sibbald <[EMAIL PROTECTED]> wrote: > Hello, > > Recently, I split the Bacula documentation (800+ pages) into the following > 7 > documents: > > Concepts and Overview Guide > Installation and Configuration Guide > Console and Operators Guide > Problem Resolution Guide > Catalog Database Guide > Utility Programs > Developers' Guide > > You can see the first cut of this work at the bottom of the following > page: > > http://www.bacula.org/en/?page=documentation > > Splitting the manual in this way has the advantages that each manual is a > more > manageable size and with a bit more work, we should be able to eliminate > duplicated material, and make it easier for users to find what they need > to > get the job done (e.g. consolidating all the problems in the Problem > Resolution Guide ...). > > One of the disadvantage is that linking between the manuals becomes more > complicated. > > Keeping in mind that this is a first cut, and that *much* more work needs > to > be done, I would be interested to hear your comments about the new > division. > Please note, there is still a lot of work to be done on eliminating > redundancy between the manuals and insuring that all problem resolution > text > is moved into the Problem Resolution Guide, and so forth. What I am most > interested in at this point is your comments on the major divisions of the > manual. > > Best regards, > > Kern > > ------------------------------------------------------------------------- > This SF.net email is sponsored by: Microsoft > Defy all challenges. Microsoft(R) Visual Studio 2008. > http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/ > _______________________________________________ > Bacula-users mailing list > Bacula-users@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/bacula-users ------------------------------------------------------------------------- This SF.net email is sponsored by: Microsoft Defy all challenges. Microsoft(R) Visual Studio 2008. http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/ _______________________________________________ Bacula-users mailing list Bacula-users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/bacula-users
