HOWTO Start

If you are interested in writing a HOWTO or mini-HOWTO, please get in touch with me first at jhall1@isd.net.

Here are a few guidelines that you should follow when writing a HOWTO or mini-HOWTO:

• 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.
  
• If you are writing a HOWTO, you must use HTML. Grab the template from template.html. This gives all of the HOWTOs a uniform look. It is very important that you format and review the output of your HOWTO.
• If you are writing a mini-HOWTO, you can either use HTML (as described above) or plain text.
• 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.
• Make sure that you are covering the most recent version of the available software. Also, be sure to include full instructions on where software can be downloaded from (FTP site name, full pathname), and the current version number and release date of the software.
• Include an FAQ section at the end, if appropriate. Many HOWTO documents need an "FAQ" or "Common Problems" section to cover information which can't be covered in the regular text.
• Use other HOWTOs or mini-HOWTOs as a model!
• Make sure that your name, email address, date, and a version number is near the beginning of the document. You could also include WWW addresses and a snail mail address if you want. The standard header is:
  Title
  Author's name and email address
  Version number and date

  for example:
  The Linux HOWTO Index
  by Greg Hankins
  v2.10.29, 31 July 1997

• Every HOWTO should include a copyright statement, like the following:

  Copyright © yyyy name of author
  
  Unless otherwise stated, FD-DOC HOWTO documents are copyrighted by
  their respective authors. FD-DOC HOWTO documents may be reproduced and
  distributed in whole or in part, in any medium physical or electronic,
  as long as this copyright notice is retained on all copies. Commercial
  redistribution is allowed and encouraged; however, the author would
  like to be notified of any such distributions.
  
  All translations, derivative works, or aggregate works incorporating
  any FD-DOC HOWTO documents must be covered under this copyright notice.
  That is, you may not produce a derivative work from a HOWTO and impose
  additional restrictions on its distribution. Exceptions to these rules
  may be granted under certain conditions; please contact the FD-DOC
  HOWTO coordinator at the address given below.
  
  In short, we wish to promote dissemination of this information through
  as many channels as possible. However, we do wish to retain copyright
  on the HOWTO documents, and would like to be notified of any plans to
  redistribute the HOWTOs.
  
  If you have any questions, please contact the FD-DOC coordinator
  at jhall1@isd.net.
  

• Lastly, be prepared to receive questions and comments about your writing.

After you have written the HOWTO, email it to me at jhall1@isd.net.

It is important that you go through me when submitting a HOWTO, as I maintain the archives and need to keep track of what HOWTOs are being written and who is doing what.

Then, all you have to do is send me periodic updates whenever appropriate.

If you have any questions, please contact the FD-DOC coordinator at jhall1@isd.net.