# Writing and submitting a HOWTO

If you would like to write a Linux HOWTO document, there are a few guidelines that you should follow.

- Format the document neatly. HOWTOs must be available in plain ASCII format, but you are free to use a formatting tool (texinfo, LameTeX, nroff) to format the document. 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.
- 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).
- 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 as a model. It is nice to have a common look and feel to HOWTO documents--- this document being an example. The easier the HOWTO is to browse, the more useful it will be to readers.

After you have written the HOWTO, mail it to me (Matt Welsh) at `mdw@sunsite.unc.edu`. I am the HOWTO coordinator---I will look over the HOWTO, and make any editorial remarks. I will also take care of approving and posting the HOWTO to the various newsgroups and uploading the HOWTO to the FTP archive sites. Of course, all credit for the HOWTO will go to the author.

It is important that you go through me when submitting a HOWTO. I maintain the HOWTO archives and need to keep track of what HOWTOs are being written and who is doing what. If you don't submit a HOWTO to me, I can't include it in the archive or add it to the HOWTO INDEX.

Once I have approved the HOWTO, I will post it and upload it to the FTP sites. I will also send you (the author) the "final" version of the HOWTO with any changes. All you have to do is send me periodic updates (every month or so, as needed) and I will take care of posting the HOWTO regularly.