home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2004 December / PCpro_2004_12.ISO / files / webserver / xampp / xampp-cocoon-addon-1.4.9-installer.exe / todo-doc.xml < prev    next >
Encoding:
Extensible Markup Language  |  2004-07-12  |  6.8 KB  |  199 lines
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!--
  3.   Copyright 1999-2004 The Apache Software Foundation
  4.  
  5.   Licensed under the Apache License, Version 2.0 (the "License");
  6.   you may not use this file except in compliance with the License.
  7.   You may obtain a copy of the License at
  8.  
  9.       http://www.apache.org/licenses/LICENSE-2.0
  10.  
  11.   Unless required by applicable law or agreed to in writing, software
  12.   distributed under the License is distributed on an "AS IS" BASIS,
  13.   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.   See the License for the specific language governing permissions and
  15.   limitations under the License.
  16. -->
  17.  
  18. <!DOCTYPE todo PUBLIC "-//APACHE//DTD Todo V1.0//EN" "todo-v10.dtd">
  19.  
  20. <!--
  21.   $Id: todo-doc.xml,v 1.3 2004/05/08 08:57:55 crossley Exp $
  22. -->
  23.  
  24.  
  25. <todo title="Documentation To Do List">
  26.  
  27.  <devs>
  28.   <!-- in strict alphabetical order -->
  29.   <person name="David Crossley" email="crossley@apache.org" id="DC"/>
  30.   <person name="Diana Shannon" email="shannon@apache.org" id="DS"/>
  31.   <person name="Volunteer needed" email="cocoon-dev@apache.org" id="open"/>
  32.  </devs>
  33.  
  34.  <actions priority="high">
  35.  
  36.   <action context="docs" assigned-to="open">
  37.    Decide priorities for initial documentation project efforts.
  38.   </action> 
  39.  
  40.   <action context="docs" assigned-to="open">
  41.    Decide how draft documentation will be managed in CVS.
  42.    Probably under the main xdocs to start with.
  43.   </action> 
  44.   
  45.   <action context="docs" assigned-to="open">
  46.    Decide how to simplify proposed content submission and review process.
  47.   </action> 
  48.   
  49.   <action context="docs" assigned-to="open">
  50.    Explore options for building "depends" hooks into 
  51.    documentation to couple document content more tightly to code evolution.
  52.    In other words, create internal document flags to help identify content
  53.    to update when a particular component/option changes.
  54.   </action> 
  55.   
  56.   <action context="docs" assigned-to="open">
  57.    Clarify any copyright issues related to contributed documentation.
  58.   </action> 
  59.     
  60.   <action context="docs" assigned-to="open">
  61.    Javadocs need simple package.html for description of each class.
  62.    See email discussion cocoon-dev
  63.    <link href="http://marc.theaimsgroup.com/?l=xml-cocoon-dev&m=102056702426129">Javadocs: need basic package information</link>
  64.   </action>
  65.   
  66.   <action context="docs" assigned-to="open">
  67.    Develop how-to author Tutorial and Recipe documents.
  68.   </action> 
  69.     
  70.   <action context="docs" assigned-to="open">
  71.    Develop how-to author a case studies/success story document.
  72.   </action> 
  73.   
  74.   <action context="docs" assigned-to="open">
  75.    Develop how-to author business case document.
  76.   </action> 
  77.   
  78.   <action context="docs" assigned-to="DS">
  79.    Develop tips on writing effectively document for contributors.
  80.   </action> 
  81.   
  82.   <action context="docs" assigned-to="DS">
  83.    Develop basic editing conventions for project.
  84.   </action> 
  85.         
  86.   <action context="docs" assigned-to="open">
  87.    Develop status page of in-process documents and topics.
  88.   </action> 
  89.       
  90.   <action context="docs" assigned-to="open">
  91.    Review all existing documentation. Update 
  92.    <link href="doc.html">Documentation Revisions</link> as appropriate. 
  93.   </action> 
  94.       
  95.   <action context="docs" assigned-to="open">
  96.    Review the titles of all existing documents. At one stage they were
  97.    deliberately kept short because of show-off banner images. Now there is no
  98.    need and titles can be properly descriptive. Also set guidelines for new
  99.    document titles. See cocoon-dev discussion
  100.    <link href="http://marc.theaimsgroup.com/?l=xml-cocoon-dev&m=101982197707050"> Re: tracks/titles</link>.
  101.   </action> 
  102.  
  103.   <action context="docs" assigned-to="open">
  104.    Harvest FAQ content from user list. Expand FAQ content. Revise faq-v10.dtd.
  105.   </action> 
  106.     
  107.   <action context="docs" assigned-to="open">
  108.    Develop and post survey to user list to assess documentation needs. 
  109.   </action> 
  110.   
  111.   <action context="docs" assigned-to="open">
  112.    Develop comprehensive how-to "wish list" cover all critical development issues. 
  113.   </action> 
  114.   
  115.   <action context="docs" assigned-to="open">
  116.    Provide technical review of draft tutorial: "Developing Your Own Generator." 
  117.   </action> 
  118.     
  119.   <action context="docs" assigned-to="open">
  120.    Expand documentation infrastructure (XSLT, indexing, etc.) to provide efficient user
  121.    access to multiple FAQs, How-Tos, Snippets, Tutorials, etc.
  122.   </action> 
  123.   
  124.   <action context="docs" assigned-to="open">
  125.    Revise web site navigation/hierarchy to make all documentation more accessible.
  126.   </action> 
  127.  
  128.  </actions>
  129.  
  130.  <actions priority="medium">
  131.  
  132.   <action context="code" assigned-to="open">
  133.    Build upon Ken's excellent Patch Queue notifier to send a reminder/prompt
  134.    to relevant mail list about outstanding DOC patches in Bugzilla.
  135.   </action>
  136.  
  137.   <action context="code" assigned-to="open">
  138.    Explore CMS-related options with Forrest project.
  139.   </action>
  140.   
  141.   <action context="docs" assigned-to="open">
  142.    Recruit users for authoring and QA testing.
  143.   </action>
  144.   
  145.   <action context="docs" assigned-to="open">
  146.    Explore other QA options, such as off-site wikis and contentEnabled 
  147.    browser capabilities.
  148.   </action>
  149.   
  150.   <action context="docs" assigned-to="open">
  151.    Decide how Cocoon project web site can be updated more frequently.
  152.   </action> 
  153.   
  154.   <action context="docs" assigned-to="open">
  155.    Edit content of existing documents, based on 
  156.    <link href="doc.html">Documentation Revisions</link>.
  157.   </action> 
  158.   
  159.   <action context="docs" assigned-to="open">
  160.    Restructure existing documents, if necessary, based on 
  161.    <link href="doc.html">Documentation Revisions</link>.
  162.   </action> 
  163.   
  164.   <action context="docs" assigned-to="open">
  165.    Develop more informative introductory pages for refactored samples.
  166.   </action> 
  167.   
  168.   <action context="docs" assigned-to="open">
  169.    Figure out how to consistently link between the Samples and the relevant
  170.    documentation and vice versa. Then create more links.
  171.   </action> 
  172.   
  173.   <action context="docs" assigned-to="open">
  174.    Develop learner's roadmaps.
  175.   </action> 
  176.   
  177.   <action context="docs" assigned-to="open">
  178.    Develop an expanded version of <link href="doc.html">Documentation Revisions</link>
  179.    to facilitate contributor and coordination efforts.
  180.   </action> 
  181.   
  182.   <action context="docs" assigned-to="open">
  183.    Review all existing scratchpad documentation. Update 
  184.    <link href="doc.html">Documentation Revisions</link> as appropriate. 
  185.   </action> 
  186.  
  187.   <action context="docs" assigned-to="open">
  188.    Decide what to do about the cTwIG (Cocoon Two Idiots Guide). After the
  189.    re-organisation of the menus, it is no longer linked in.
  190.    Perhaps some of it should move into the new How-to docs.
  191.    There is also an old patch waiting in Bugzilla ...
  192.    <link href="http://nagoya.apache.org/bugzilla/show_bug.cgi?id=6435">Bug 6435</link>
  193.    which contains neglected contributions.
  194.   </action> 
  195.    
  196.  </actions>
  197.  
  198. </todo>
  199.