Article template for authors
HOW TO USE THIS PAGE: Copy the template below to your article. Replace the sections and headings with your own content, following this structure as a guide.
Explain one or two situations in which a user would need to use the process you will describe. Don’t explain the process here. The point of the introduction is to introduce the concepts the reader will put to use later, and to explain why it’s even useful to begin with.
Here’s a short example for an article about setting the hostname: “The computer’s hostname helps distinguish the system on a network. If you have appropriate privileges, you can set your system’s hostname to something that helps you identify it in your home or office network.”
If there’s anything the user needs to know in order to use the process, describe it here. For instance, in the hostname example, you would describe that only lowercase letters a-z, numerals 0-9, or the dash “-” may appear in a hostname. You might also tell them whether they need to be on a specific Fedora edition or version.
Running the most common process
Describe the process one step at a time. Describe the simplest and most common usage first. Assume the reader will try the first process they see.
Use a graphical interface as the first and most common process. Document the default installation wherever possible. Use a screenshot, and don’t use your own customized user account. Use a fresh user account so it has a non-customized and stock appearance.
You may follow this case with a command-line equivalent in an additional section.
Running a more complex or less common process
You can describe a less common process as well. In this case, describe why it is useful. Be honest with yourself about whether this process is actually useful. Don’t use the article as a way of showing off your deep knowledge of a tool.
If there are common references, you can include them at the bottom. Do not point to dated information. Only use resources that are unlikely to change, are undated, or are well maintained.