On Thursday 12 December 2002 12:21 pm, Peter Simons wrote:
> 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.
Okay.
> (2) Documentation authors should be free to use (almost) any document
> format they like.
I'm not sure I understand what you mean by this. Do you mean that library
authors should be able to do anything that DocBook allows?
> (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.
Okay.
> (4) It must be possible to link reliably from one library
> documentation into another one.
Even if the documentation for the libraries was generated separately? I don't
like that as a requirement, but only because I don't know how to do it. I
think DocBook olinks can do such a thing, but I don't understand them well
enough to make any claim.
> (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.
Okay.
> 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?
Sure.
Doug
-------------------------------------------------------
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
