By MasterC at 2003-08-21 18:52
The following LinuxAnswer describes how to create and format a LinuxAnswer, a howto article from LinuxQuestions.org.
The title of the LinuxAnswer should be appropriate for the content of the How-To, nor does it need to be super creative. Just state in simplest terms what the LinuxAnswer is going to teach.
If you need to describe a command or screen output, use the BB/VB codes. These codes can be found in the FAQ of the site.
- [code][/code] should braqcket all terminal commands and terminal output.
- [b][/b] for commands that are entered by the user.
- [i][/i] for commands that are variable, such as username.
- [quote][/quote] for presenting quotes, you can give credit where credit is due this way, as well as break out a point of a paragraph to show importance.
All of the above examples have spaces between the brackets and the first character of the code, this is to show you the code without actually using it. You must remove the spaces in your own articles so the coding will be used properly. See the FAQ for more info on BB/VB code.
Thank you for wanting to create a LinuxAnswer.
Here are some general guidelines to help you when deciding what and how to write:
- Use English. Eventually we may make LinuxQuestions.org a multi-lingual site, but for now, please keep articles and other content in English.
- Focus on a single idea. Instead of "how to use digital cameras," perhaps write "how to use application X to organize your photos."
- Look for even narrower tasks. You would be amazed at how many more times people search for “listen to MP3s with Amarok” versus “listen to music on Linux.”
- Use a recipe format. After a little preliminary info, use numbered steps. Make the first sentence of the step the action and the second sentence the result. For example:
1.Click the File | Open menu. The Open dialog box will appear.
2.Select the file you want to open.
3.Click OK. The selected file will open.
- Avoid distro specificity. Exceptions are noted below.
- Don't be redundant. Make sure the content is original and not reproducing a topic that is already posted somewhere else. A LinuxAnswer that contains things that are straight out of the TLDP and has very little else might not be accepted
- Related to this, before writing a LinuxAnswer you may wish to contact us via the contact form to ensure that the subject you would like to use is not already being worked on on Linux.
- If you do copy someone else's work, give them credit, include links, and possibly even ask the original author permission.
If your FAQ is titled "How to setup a working firewall using IPTables," it is likely going to be in your best interest to be distribution neutral. Meaning, that anyone on any distro, using the standard set of tools could follow the instructions and successfully have a working firewall. Conversely, if your How To is titled "How to use the Mandriva Control Center to create new users," then giving distro-specific answers would be expected.
Providing a summary is not always necessary, but helps for those how-to's that are extremely long, or cover a lot of ground. A summary should be short, to the point and be as general as possible. You should do your best to refer only to your own document at this point, and provide references in a follow on section titled "References" or something along those lines, or "For More information..."
(Updated by: bproffitt on 03/15/10)