Wish List for Open Source Docs
By Eric Armstrong on Jan 22, 2008
This is my feature wish list for a documentation system that would make it possible to easily interact with the open source community--and eventually, to enable augmented collaboration of all kinds. Of course, I see it being implemented with DITA and JRuby, but only because they meet the critical requirements listed here:
- A Wiki-accessible, WebDAV-enabled repository that handles XML objects, allowing them to be edited as Wiki text, in an online WYSIWYG editor, or with a remote editor.
- Online pages with comment capability and multi-level access the allows viewing, commenting, comment administration, or editing, depending on authorization.
- Fine-grained notification settings to users can be notified of all changes to a page, or only major changes, with independent settings for pages the user has authored, pages the user has edited, and pages the user has bookmarked, with overrides on individual pages.
- "Spanning" controls for access and notifications, so you can set them at different nodes in the information hierarchy and have them apply to the subtree rooted at that node.
- Support for document structures that allow for multi-dimensional conditionals at all levels of the information hierarchy, transclusions, and independent specialization.
- Link checking and doc-linting of the above to maintain quality.
- An integrated build, translation, and document-on-demand system that produces PDF, HTML, Help, printed books, online tutorials, and classroom materials.
- Ruby Rocks!
- Domain Specific Language PowerTools Promote Elegance
- DITA: One Cool Document Format
- Enabling Collaborative Design-and-Decision Discussions, Online