shannon 02/05/07 19:38:17
Modified: src/documentation/xdocs/plan todo-doc.xml
Log:
added todo doc items
Revision Changes Path
1.3 +140 -6 xml-cocoon2/src/documentation/xdocs/plan/todo-doc.xml
Index: todo-doc.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/todo-doc.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- todo-doc.xml 7 May 2002 08:25:59 -0000 1.2
+++ todo-doc.xml 8 May 2002 02:38:17 -0000 1.3
@@ -3,11 +3,11 @@
<!DOCTYPE todo PUBLIC "-//APACHE//DTD Todo V1.0//EN" "../dtd/todo-v10.dtd">
<!--
- $Id: todo-doc.xml,v 1.2 2002/05/07 08:25:59 crossley Exp $
+ $Id: todo-doc.xml,v 1.3 2002/05/08 02:38:17 shannon Exp $
-->
-<todo title="Documentation Things To Do">
+<todo title="Documentation To Do List">
<devs>
<!-- in strict alphabetical order -->
@@ -18,19 +18,108 @@
<actions priority="high">
- <action context="docs" assigned-to="DS">
- Develop an initial overview plan for the new documentation project.
+ <action context="docs" assigned-to="open">
+ Decide priorities for initial documentation project efforts.
</action>
<action context="docs" assigned-to="open">
Decide how draft documentation will be managed in CVS.
</action>
-
+
+ <action context="docs" assigned-to="open">
+ Decide how to simplify proposed content submission and review process.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Explore options for building "depends" hooks into
+ documentation to couple document content more tightly to code evolution.
+ In other words, create internal document flags to help identify content
+ to update when a particular component/option changes.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Clarify any copyright issues related to contributed documentation.
+ </action>
+
<action context="docs" assigned-to="open">
Javadocs need simple package.html for description of each class.
See email discussion cocoon-dev
<link
href="http://marc.theaimsgroup.com/?l=xml-cocoon-dev&m=102056702426129";>Javadocs:
need basic package information</link>
</action>
+
+ <action context="docs" assigned-to="DS">
+ Develop how-to author FAQ, How-To, Tutorial, and Snippet documents.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Develop how-to author a case studies/success story document.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Develop how-to author business case document.
+ </action>
+
+ <action context="docs" assigned-to="DS">
+ Develop tips on writing effectively document for contributors.
+ </action>
+
+ <action context="docs" assigned-to="DS">
+ Develop basic editing conventions for project.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Develop how-to contribute to documentation effort document.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Develop dtds, templates, and stylesheets for all how-to author documents.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Develop status page of in-process documents and topics.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Review all existing documentation. Update
+ <link href="doc.html">Documentation Revisions</link> as appropriate.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Harvest FAQ content from user list. Expand FAQ content. Revise
faq-v10.dtd.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Develop and post survey to user list to assess documentation needs.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Develop comprehensive how-to "wish list" cover all critical development
issues.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Provide technical review of draft tutorial: "Developing Your Own
Generator."
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Provide technical review of draft tutorial/how-to: "Developing Your
Own Source."
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Expand documentation infrastructure (XSLT, indexing, etc.) to provide
efficient user
+ access to multiple FAQs, How-Tos, Snippets, Tutorials, etc.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Revise web site navigation/hierarchy to make all documentation more
accessible.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Add documentation effort-related website pages to documentation build and
sitemap to increase visibility and coordinate efforts. This includes planning
docs and contributor how-tos.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Update and add category headings to Cocoon Links page.
+ </action>
</actions>
@@ -44,7 +133,52 @@
<action context="code" assigned-to="open">
Set up the initial "Changes" document in CVS.
</action>
-
+
+ <action context="code" assigned-to="open">
+ Explore CMS-related options with Forrest project.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Recruit users for authoring and QA testing.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Explore other QA options, such as off-site wikis and contentEnabled
+ browser capabilities.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Decide how Cocoon project web site can be updated more frequently.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Edit content of existing documents, based on
+ <link href="doc.html">Documentation Revisions</link>.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Restructure existing documents, if necessary, based on
+ <link href="doc.html">Documentation Revisions</link>.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Develop more informative introductory pages for refactored samples.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Develop learner's roadmaps.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Develop an expanded version of <link href="doc.html">Documentation
Revisions</link>
+ to facilitate contributor and coordination efforts.
+ </action>
+
+ <action context="docs" assigned-to="open">
+ Review all existing scratchpad documentation. Update
+ <link href="doc.html">Documentation Revisions</link> as appropriate.
+ </action>
+
</actions>
</todo>
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
