5 Writing and submitting a HOWTO

Contents of this section

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.
• You may wish to use the Linuxdoc-SGML package, available from ftp.cs.cornell.edu:/pub/mdw/, to format the HOWTO. This package allows you to produce LaTeX, plain ASCII, and HTML from a single source document, and was designed specifically with the HOWTOs in mind. If you are writing a new HOWTO you should seriously consider this.
• 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.

After you have written the HOWTO, mail it to me (Matt Welsh) at mdw@sunsite.unc.edu. If you have use Linuxdoc-SGML, simply mail me the SGML source; I take care of formatting the documents. I'll also take care of archiving the HOWTO and posting it to the various newsgroups.

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.

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.

Next Chapter, Previous Chapter

Table of contents of this chapter, General table of contents

Top of the document, Beginning of this Chapter