How to Write Wikihtp Tutorial

From WikiHTP

Search before you start a new tutorial. Since a wiki works best when there is only one page per topic, duplicate pages will be merged. Before starting a new article first search WikiHTP. If your exact topic already exists, please edit the existing tutorial. You should feel free to make dramatic changes to existing tutorials in the spirit of improvement.

The following is a brief introduction to the standard tutorial format:

Title[edit]

Create a brief and accurate title. The title should be the most concise, most commonly searched way to describe the activity. See our guide to titles for more information.

Introduction[edit]

Write a brief summary of the topic that invites your reader to continue reading. Ideally, this area should consist of about 40 to 70 words, but you can use more or less if necessary.

Steps[edit]

  1. Understand that the steps constitute the main body of your instructions. When possible, place the steps in chronological order.
  2. Be concise. Readers appreciate clear and concise instructions.
  3. Avoid the use of introductory phrases, such as "In the next step", "The next thing to do is", "Then", "Next," or "Now that you have done Step 1, here is Step 2."
  4. Make sure the steps do not raise new questions that the copy does not answer. There may be an occasional step that requires more explanation. If so, give the explanation. Don't oversimplify to the point that the step is difficult to follow.
  5. Add a bit of explanation to a step if it helps the user.
  6. Recognize you will be able to give helpful notes and warnings in other fields.
  7. Avoid the first person. While writing on WikiHTP does not need to be neutral, the best writing should not make any personal references to the authors or authors website.

Notes[edit]

  • The "Notes" field is optional. The Notes field gives you a little more latitude to explain a step or to give further advice. For example, for a WikiHTP about making a concatenation string, you might add a note that says, "When using coalescing operator on string concatenation don't forget to use parentheses ()."
  • Good writing excludes the use of:
    • ALL CAPS
    • instant messenger language abbreviations - R U OK?
    • emoticons - :)
    • excessive punctuation - !!!
    • sentences starting with lower case - "null coalescing (??) is a new operator introduced in PHP 7."

Warnings[edit]

  • The "Warnings" field is optional. It is used specifically for warnings of possible dangerous or harmful consequences and risks, or it can be used for explaining any undesirable results that might occur when following the steps of the relevant WikiHTP article. These can involve anything from advisories about the crash of data or storage if you don't back up your data.

Things You'll Need[edit]

  • This is an optional bullet-pointed list of software.

Related WikiHTPS[edit]

  • Use this section to Add Related WikiHTPs on similar topics. For example, a page on how to create a login validation might link to pages on how to prevent SQL injection.
  • How to View Your WikiHTP Watchlist

Sources and Citations[edit]

  • This optional section can contain links that provide attribution of where the article came from, or other sources and cites mentioned in the article. If you are providing attribution for the article be sure that you have already received permission to use the content.
  • http://www.example.com - Source of information on (insert specifics here).

Edit Summary[edit]

  • Leave a note here to explain your edit details to other authors what you did and why. For example, you might write "spelling", or "added details" or "removed personal references".

Some Final Thoughts[edit]

Thanks again for helping build the world's largest collection of free, "how-to-program" wiki. When writing a WikiHTP please keep in mind that every page should be clear, concise, and accurate. And while it should go without saying, please be sure that all your contributions to WikiHTP are entirely your own, or that you have permission from the copyright holder to post them on WikiHTP.

We are so glad you have chosen to join us in building this useful resource. If you have any questions please don't hesitate to email us.

Now that you know how to write a WikiHTP tutorial please feel free to and/or start writing!

About This Tutorial

This page was last modified on 31 March 2018, at 21:14.