<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V1.0//EN" "http://apache.org/forrest/dtd/howto-v10.dtd">

<howto>
 <header>
  <title>How to Author a How-To</title>
  <version>0.2</version>
  <authors>
   <person name="Diana Shannon" email="shannon@apache.org"/>
  </authors>
  <notice>This document is a sample to test the new howto-v11.dtd</notice>
  <abstract>This How-To describes the steps necessary to write a How-To for Cocoon. The Cocoon documentation project needs your help. Writing a Cocoon How-To is a valuable way to give back to the community.</abstract>
  <last-modified-content-date date="2002-05-19"/>
 </header>


  <audience title="Intended Audience">
<p>
Cocoon users who are ready to share their knowledge and experiences with the larger Cocoon community.
</p>
  </audience>
  
  <purpose title="Purpose">
<p>
These guidelines are based on successful how-to document structures used by other open source projects with diverse author groups. Following these tried and true guidelines will help to insure the effectiveness of your work.
</p>
  </purpose>


  <prerequisites title="Prerequisites">
<p>
How-To authors should have:
</p>
<ul>
<li>A unique How-To topic, related to using Cocoon, which fulfills a specific need. Check out existing How-Tos to find a niche for your work. Consider posting your idea for the How-To to cocoon-user list, to make sure another author's draft is not already in process.</li>
<li>A sufficient ability in English to write the FAQ. If you need a little extra help with language, consider partnering with another user with more advanced English writing skills.</li>
<li>Currently, the Cocoon documentation project is still working out the exact details for a How-To dtd and template. For now, just edit the most recent version of any existing How-To, filling in your own content as necessary. Make sure you use most recent version of document dtd to validate your How-To before submitting. You will find it in <code>src/documentation/xdocs/dtd</code> in your cocoon distribution.</li>
</ul>
<note>Within Forrest, the dtd is located in <code>src/resources/schema/dtd</code>.</note>
</prerequisites>

  <steps title="Steps">
<p>
Here's how to proceed.</p>

  <section>
    <title>Write the Overview</title>
<p>
An overview helps potential readers to determine quickly if a particular How-To matches their interests or needs. In a few sentences, summarize the main points of your How-To. Make sure to include any critical definitions which will help readers evaluate the utility of your How-To. Consider writing the overview last, after you have completed all other sections.
</p>
  </section>

  <section>
    <title>Describe your Intended Audience</title>
<p>
If your How-To is targetted at a specific audience, describe it here. For example, potential readers will have different levels of skill using Cocoon. They will also bring different areas of expertise and backgrounds to their How-To learning experience. When you clarify your target audience up front, you will save all other readers time and confusion. 
</p> 
  </section>

  <section>
    <title>State the Purpose</title>
<p>
State the purpose of your How-To. Explain how the reader will benefit by reading it. Give your reader an incentive or two to continue. 
</p>
  </section>

  <section>
    <title>List any Prerequsites</title>
<p>
Inform your reader about any required knowledge, configuration, or resources they may need before stepping through your How-To. Assist them in this preparation by linking to other useful resources on the Cocoon site or the web. Helping your readers to prepare increases the likelihood that they will continue reading your How-To.
</p>
  </section>

  <section>
    <title>Describe the Steps of your How-To</title>
<p>
In a precise, step-by-step approach, walk your reader through the process. Make sure your reader can reproduce your intended result by following your exact steps. Make the learning process efficient by supplying sample code snippets or configuration details as necessary.
</p>
  </section>

  <section>
    <title>Extend the Learning</title>
<p>
Provide your reader with a few real-world examples of how the techniques or capabilities gained from your How-To could be applied. Reward the reader for successfully completing the How-To with a few ideas about how it will pay off.
</p>
  </section>


  <section>
    <title>Summarize the Entire Process</title>
<p>
In a few sentences, remind the reader what they have just learned. This helps to reinforce the main points of your How-To.  
</p>
  </section>


  <section>
    <title>Additional Tips or FAQs</title>
<p>
In some cases, step-by-step instructions simply aren't enough. Use this section to pass on any other tips or frequently asked questions. Anticipating the needs of your readers will increase the overall success of your writing effort.
</p>
  </section>

  <section>
    <title>References</title>
<p>
Remember to acknowledge any third-party resources or individuals who contributed to the development of your How-To. Consider providing links for those motivated readers who want to learn more.
</p>
  </section>
  
  <section>
    <title>Get some feedback</title>
<p>
Ask a few other Cocoon users to proofread your How-To. Or, post a text version of it to the cocoon-user list, and ask for comments.
</p> 
  </section>
  
  <section>
    <title>Submit via Bugzilla</title>
<p>
Create an attachment for your How-To document, and submit it via Bugzilla. 
<!-- link to How-To Bugzilla here -->
</p> 
  </section>
    

  </steps>

  <extension title="Extension">
<p>
Cocoon solutions can be extended to cover many different problem domains. A nearly unlimited number of potential How-To topics, from simple to complex, are available right now, limited only by your imagination. 
</p>
  </extension>

  <faqs title="Frequently Asked Questions">
  
  <faq>
   <question>
    What is the difference between a How-To and a tutorial?
   </question>
   <answer>
    <p>
    The goal of a How-To is to help the reader to accomplish a specific task with clear and consise instructions. While tutorials may contain How-To-like instructions and content, they also include additional background and conceptual content to help teach their readers higher order concepts along the way. How-Tos are concerned about filling an immediate, short-term need. Tutorials often provide long-term knowledge which can be applied across a range of needs.
    </p>
   </answer>
  </faq>

  <faq>
   <question>
    What spelling convention should I follow?
   </question>
   <answer>
    <p>
     Use whatever spelling convention (American, British, etc.) that is most intuitive to you.
    </p>
   </answer>
  </faq>
  </faqs>
  
  <tips title="Tips">
  
  <section>
    <title>How-To dtd</title>
<p>
The document structure of Cocoon's How-To page is likely to change soon. Please note that this HOWTO page is likely to change as well.
</p>
  </section>
  
  </tips>

  <references title="References">
<p>
This is not the first, nor will it be the last, How-To on writing How-Tos. For other ideas and opinions on the matter, check out the following sources.
</p>
  <ul>
<li>
Joel D. Canfield's <link href="http://www.evolt.org/article/How_To_Write_A_How_To/9741/18250/index.html">How to Write a How-To</link> on evolt.org.
</li>
<li>
The Linux Documentation Project's <link href="http://www.tldp.org/HOWTO/HOWTO-INDEX/index.html">HOWTO</link> index page provides many excellent How-To documents to inspire your efforts.
</li>
  </ul>
  
  </references>
  
</howto>
