I have been thinking a lot about the issue of how to organize the
whole documentation effort, and I must admit that I am quite lost. So
I thought, that it would be best (for me) to just list the
requirements we have. Maybe we can find good solutions for each of
them in the (hopefully) following discussion.
(1) Each library documentation should be self-contained; it must be
possible to build each document independent of the rest.
(2) Documentation authors should be free to use (almost) any document
format they like.
(3) (a) Tools must exist that generate indices of functions, classes,
concepts, etc. automatically from the library documentation.
(b) It must be possible to generate those indices over _all_
library documentations as well.
(4) It must be possible to link reliably from one library
documentation into another one.
(5) It must be possible to build one big book containing all
documentations.
(6) All documents (including indices, etc.) must be convertable into
plain DocBook so that they can be processed with standard tools.
Did I miss anything? Did I list a requirement that we do not have?
-peter
P. S.: I'll add these to the Wiki pages so that we can use them as
means of documenting our rationale, OK?
-------------------------------------------------------
This sf.net email is sponsored by:
With Great Power, Comes Great Responsibility
Learn to use your power at OSDN's High Performance Computing Channel
http://hpc.devchannel.org/
_______________________________________________
Boost-docs mailing list
[EMAIL PROTECTED]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
