Questions about documentation management
| From: | Cheetham, Anastasia | Date: | Wed, 19 Jan 2011 15:32:23 +0000 |
| Subject: | Questions about documentation management | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969382457@lists.php.net to get a copy of this message | ||
Hello,
My name is Anastasia Cheetham. I'm a developer with and the documentation lead for the Fluid
Project (http://fluidproject.org). We're beginning the process of restructuring and redesigning
the documentation for our Infusion framework. Part of that process will include migrating to a new
platform for the creation and distribution of documentation, and we're interested in learning
about the experiences of other open source projects, including PHP.
I've had a look at you How To pages for contributing documentation, and I see that you use
DocBook. I'd be interested in hearing your thoughts on DocBook:
- What do you feel are its strengths? What are its weaknesses?
- How easy or hard it is to customize the look and feel of the interface with DocBook? i.e. style,
layout, navigation, etc.
- Do you use any form of auto-generated API documentation? If so, how to you manage integration with
more narrative text such as tutorials, etc?
I thank you very much for your time, and for any thoughts you can share.
--
Anastasia Cheetham Inclusive Design Research Centre
acheetham@ocad.ca Inclusive Design Institute
OCAD University