68 lines
2.8 KiB
HTML
68 lines
2.8 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
|
<HTML>
|
|
<HEAD>
|
|
<META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.21">
|
|
<TITLE>: Writing the HOWTO</TITLE>
|
|
<LINK HREF="Howtos-with-LinuxDoc-10.html" REL=next>
|
|
<LINK HREF="Howtos-with-LinuxDoc-8.html" REL=previous>
|
|
<LINK HREF="Howtos-with-LinuxDoc.html#toc9" REL=contents>
|
|
</HEAD>
|
|
<BODY>
|
|
<A HREF="Howtos-with-LinuxDoc-10.html">Next</A>
|
|
<A HREF="Howtos-with-LinuxDoc-8.html">Previous</A>
|
|
<A HREF="Howtos-with-LinuxDoc.html#toc9">Contents</A>
|
|
<HR>
|
|
<H2><A NAME="s9">9.</A> <A HREF="Howtos-with-LinuxDoc.html#toc9">Writing the HOWTO</A></H2>
|
|
|
|
<H2><A NAME="ss9.1">9.1</A> <A HREF="Howtos-with-LinuxDoc.html#toc9.1">Before you start writing</A>
|
|
</H2>
|
|
|
|
<P>First join the discuss list by going to
|
|
<A HREF="www.en.tldp.org">www.en.tldp.org</A>
|
|
and submit your proposal to this list. If you're taking over an
|
|
unmaintained HOWTO, contact the former author. This may required by
|
|
the copyright-license but you should do it out of courtesy even it
|
|
it's not required.</P>
|
|
|
|
<H2><A NAME="ss9.2">9.2</A> <A HREF="Howtos-with-LinuxDoc.html#toc9.2">Guidelines</A>
|
|
</H2>
|
|
|
|
<P> These are mostly by Tim Bynum (a former HOWTO coordinator).
|
|
<UL>
|
|
<LI> Be sure and use an accepted format (such as LinuxDoc :-).</LI>
|
|
<LI> Try to use meaningful structure and organization, and write
|
|
clearly. Remember that many of the people reading HOWTOs do not speak
|
|
English as their first language.</LI>
|
|
<LI> Make sure that all of the information is correct. I can't stress
|
|
this enough. When in doubt, speculate, but make it clear that you're
|
|
only guessing. I use ?? if I'm not sure.</LI>
|
|
<LI> Make sure that you are covering the most recent version of the
|
|
available software.</LI>
|
|
<LI> Consider including a "FAQ" section or sections called
|
|
"Common Problems" or "Trouble Shooting".</LI>
|
|
<LI> Be sure to copyright it in your name and include a license
|
|
which meets the requirements stated in the LDP manifesto.</LI>
|
|
<LI> Use the standard header with title, author, and date
|
|
(including a version number). See
|
|
<A HREF="Howtos-with-LinuxDoc-5.html#example_3">Example 3</A></LI>
|
|
<LI> Lastly, be prepared to receive email questions and comments
|
|
from readers. How much you help people is up to you but you should
|
|
make use of good suggestions and reports of errors. You may also
|
|
get some "thank you for writing this" email. </LI>
|
|
</UL>
|
|
</P>
|
|
<H2><A NAME="ss9.3">9.3</A> <A HREF="Howtos-with-LinuxDoc.html#toc9.3">Submitting the HOWTO, etc.</A>
|
|
</H2>
|
|
|
|
<P> After you have written the HOWTO, email the SGML source to
|
|
submit@tldp.org. Then all you need to do is to keep the HOWTO
|
|
up-to date by submitting periodic updates to the same email as you
|
|
used for the first edition.</P>
|
|
|
|
<HR>
|
|
<A HREF="Howtos-with-LinuxDoc-10.html">Next</A>
|
|
<A HREF="Howtos-with-LinuxDoc-8.html">Previous</A>
|
|
<A HREF="Howtos-with-LinuxDoc.html#toc9">Contents</A>
|
|
</BODY>
|
|
</HTML>
|