Document refactoring
Note: This page is out-of-date.
Issue owner:
Don Day <dond at us dot ibm dot com>
Statement of problem or objective:
The documentation at the Sourceforge site is a mix of information for both developers and end-users. This proposal is to move the end-user documentation to dita.xml.org, and to revise the web site for the developer documentation and for downloading.
Is this architecture, function, fix, or other?
Architecture (information architecture).
Goals of this proposal:
The owners of this item will asses which documents are for end users and will reorganize those topics into a new "Toolkit User Guide" to be posted at the DITA Focus Area. The remaining documents (architecture and project categories, mostly) will be revised a new map for the dita-ot home page. The instructions for what to download need to stay on this site and be very clear about what to get and how to install. This work is mostly creating new maps for existing material. Several new topics might be required for new 1.3 features.
Use cases:
1. A user cannot find how to install the Idiom FO. It turns out that the installation information is inside the zip file. There was no indication in the web site on how to download and install plugins--the plugin info that is currently there appears to be for developers.
2. Users complain that the DITA-ot home page is plain and hard to navigate. We considered having a wiki for the ot home page, but this effort replicates the functionality and community that is already at the DITA Focus Area site.
Stakeholders:
List of those who request or need the proposed item.
dita-users (889 members as of May 18 2006, plus hundreds more users who are not list members)
Interested parties:
List of people interested in potential meetings or discussions. Use obfuscated addresses, please. For example, dond at us dot ibm dot com
Joann Hackos and Jennifer Linton
Anna van Raaphorst
Don Day
Proposed design:
This will be left up to the person(s) who signs up for the effort.
Note: All design discussions should occur on the dita-ot-developer list at the dita-ot sourceforge site.
- Login to post comments
- 8967 reads