| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html> |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Todo List</title> |
| <link href="http://purl.org/DC/elements/1.0/" rel="schema.DC"> |
| </head> |
| <body> |
| |
| |
| <devs> |
| <!-- in strict alphabetical order --> |
| |
| <person email="crossley@apache.org"> |
| <a name="DC"></a> |
| </person> |
| |
| <person email="shannon@apache.org"> |
| <a name="DS"></a> |
| </person> |
| |
| <person email="cocoon-dev@apache.org"> |
| <a name="open"></a> |
| </person> |
| |
| </devs> |
| |
| |
| <h1>high</h1> |
| <ul> |
| <li> |
| <strong>[docs]</strong> |
| Decide priorities for initial documentation project efforts. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Decide how draft documentation will be managed in CVS. |
| Probably under the main xdocs to start with. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Decide how to simplify proposed content submission and review process. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| 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. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Clarify any copyright issues related to contributed documentation. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Javadocs need simple package.html for description of each class. |
| See email discussion cocoon-dev |
| <a class="external" href="http://marc.theaimsgroup.com/?l=xml-cocoon-dev&m=102056702426129">Javadocs: need basic package information</a> |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Develop how-to author Tutorial and Recipe documents. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Develop how-to author a case studies/success story document. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Develop how-to author business case document. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Develop tips on writing effectively document for contributors. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Develop basic editing conventions for project. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Develop status page of in-process documents and topics. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Review all existing documentation. Update |
| <a actuate="user" href="doc.html" show="replace" type="simple">Documentation Revisions</a> as appropriate. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Review the titles of all existing documents. At one stage they were |
| deliberately kept short because of show-off banner images. Now there is no |
| need and titles can be properly descriptive. Also set guidelines for new |
| document titles. See cocoon-dev discussion |
| <a class="external" href="http://marc.theaimsgroup.com/?l=xml-cocoon-dev&m=101982197707050"> Re: tracks/titles</a>. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Harvest FAQ content from user list. Expand FAQ content. Revise faq-v10.dtd. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Develop and post survey to user list to assess documentation needs. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Develop comprehensive how-to "wish list" cover all critical development issues. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Provide technical review of draft tutorial: "Developing Your Own Generator." |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Expand documentation infrastructure (XSLT, indexing, etc.) to provide efficient user |
| access to multiple FAQs, How-Tos, Snippets, Tutorials, etc. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Revise web site navigation/hierarchy to make all documentation more accessible. |
| → </li> |
| </ul> |
| |
| |
| <h1>medium</h1> |
| <ul> |
| <li> |
| <strong>[code]</strong> |
| Build upon Ken's excellent Patch Queue notifier to send a reminder/prompt |
| to relevant mail list about outstanding DOC patches in Bugzilla. |
| → </li> |
| <li> |
| <strong>[code]</strong> |
| Explore CMS-related options with Forrest project. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Recruit users for authoring and QA testing. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Explore other QA options, such as off-site wikis and contentEnabled |
| browser capabilities. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Decide how Cocoon project web site can be updated more frequently. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Edit content of existing documents, based on |
| <a actuate="user" href="doc.html" show="replace" type="simple">Documentation Revisions</a>. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Restructure existing documents, if necessary, based on |
| <a actuate="user" href="doc.html" show="replace" type="simple">Documentation Revisions</a>. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Develop more informative introductory pages for refactored samples. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Figure out how to consistently link between the Samples and the relevant |
| documentation and vice versa. Then create more links. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Develop learner's roadmaps. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Develop an expanded version of <a actuate="user" href="doc.html" show="replace" type="simple">Documentation Revisions</a> |
| to facilitate contributor and coordination efforts. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Review all existing scratchpad documentation. Update |
| <a actuate="user" href="doc.html" show="replace" type="simple">Documentation Revisions</a> as appropriate. |
| → </li> |
| <li> |
| <strong>[docs]</strong> |
| Decide what to do about the cTwIG (Cocoon Two Idiots Guide). After the |
| re-organisation of the menus, it is no longer linked in. |
| Perhaps some of it should move into the new How-to docs. |
| There is also an old patch waiting in Bugzilla ... |
| <a class="external" href="http://issues.apache.org/bugzilla/show_bug.cgi?id=6435">Bug 6435</a> |
| which contains neglected contributions. |
| → </li> |
| </ul> |
| |
| |
| </body> |
| </html> |
