Ericka Abraham <[EMAIL PROTECTED]> writes: >> The next thing I would ask Ericka to do for us, if she was still >> interested, would be to "teach a man how to fish." That is, help us >> develop web pages that would consist of guidelines and other >> information for Boost authors wishing to write good documentation, >> including a totally revamped version of >> http://boost.org/more/writingdoc/index.html > > I would enjoy this project as well, but several questions arise. > How many of the subjects need reworking?
I don't know. Making those determinations (with help from others) would be part of the job. As a first cut: a. We might need examples of what works and what doesn't work; that would be a new subject b. Probably a great deal more emphasis should be placed on understandable tutorial documentation. c. We have new documentation tools (quickbook, boostbook, restructuredtext) so the section on HTML structure may be at least partially obsolete. d. We probably need a section on documenting Concepts. > Is there additional source material that needs to be incorporated? > And where do I begin? I'm afraid there might not be anybody who can tell you where to start and that we need someone to step up and take a leadership role. It doesn't mean doing everything yourself, without feedback from the group, but it does mean making some decisions about what _you_ think needs to be done and proposing them here. -- Dave Abrahams Boost Consulting www.boost-consulting.com ------------------------------------------------------------------------- Take Surveys. Earn Cash. Influence the Future of IT Join SourceForge.net's Techsay panel and you'll get the chance to share your opinions on IT & business topics through brief surveys - and earn cash http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV _______________________________________________ Boost-docs mailing list [email protected] Unsubscribe and other administrative requests: https://lists.sourceforge.net/lists/listinfo/boost-docs
