How to write a HOWTO

From Alpine Linux
Jump to: navigation, search

If you are reading this, it probably means you are interested in contributing a Howto or Tutorial to Alpine Linux Wiki. This is great! Just follow those simple steps and you will end up with a great howto in no time.

Contents

Writing the HOWTO

Know your readers and what you are trying to tell them to do.

  1. Login to Alpine Linux Wiki.
    Tip: If you have never logged in, click the Log in / create account on the top-right, and then click the Create an account link.
  2. Edit any Alpine Linux Wiki page, adding a link to your new, not yet existent page: [[How To Write A HOWTO]]
  3. Click the link, How to write a HOWTO.
    Alpine Linux Wiki opens the new page for editing.
  4. Paste the Basic HOWTO Template into your new HOWTO.
  5. Follow the instructions in the template.

Learn to format Wiki text as you write:

  • By reading the Text Formatting Rules
  • By clicking the Edit page button on Alpine Linux Wiki articles to read the source
  • By experimenting

Basic HOWTO Template

A WikiText skeleton of a basic HOWTO:

=How To Do Something=

Summarize your article here so readers can decide
quickly whether to read it.

=Before You Start Title=
Your readers might need to get ready before they can do the work.
If so explain those prerequisites first. This section might alternatively 
contain background information readers need to know before they can make 
sense of your example or carry out your instructions.

=Doing Something Title=
Write the steps of how to do something in this section.
If possible, show an example first, then tell your readers the steps.
Break this procedure into separate procedures to avoid more than
about 7-9 steps per procedure.

 INSERT GREAT EXAMPLE HERE

#Answer the following three questions, at least in your head.
##What do I explain how to do?
##How do I do that?
##What do HOWTO readers already know about doing that?
#Write up a good example. This ensures you can do it.
#Write up the steps to do it.
#Write the background info/prerequisites readers need.
#Write the summary.
#Clean up your work.
#Revise, revise, revise.

=See Also=
If you ought to point your readers to related information
they no doubt need but that does not fit in your HOWTO, add links here.

See Also