Forum OpenACS Q&A: Response to User Documentation

Collapse
Posted by Torben Brosten on
Venkatesh Goteti,

Current OpenACS documentation standards exist (for 4.5) at https://openacs.org/doc/openacs-4/docbook-primer.html. As you state, the guides are specific to publishing style and do not help much with writing style standards and goals of each documentation. I'm writing a comprehensive list of requirements/goals and plans for the docs to help provide direction for completing and maintaining all the docs. My own efforts are focused on writing user documentation for the system in general (not for the packages yet). Currently, I have collected about 22 pages of notes (48k txt file) about the doc standards from the board discussions, current docs etc. in addition to other notes that may be helpful to end-users. I will post the document standards guidelines in the documentation area of the CVS (and post a message to the board) as soon as it becomes useful.

Roberto and Vinod, I'll send you copies so you have a chance to revise it before publishing also.