HOWTO: Create a guide

Discussion in 'SteamRep Guides' started by SilentReaper(SR), Feb 11, 2012.

  1. SilentReaper(SR)

    SilentReaper(SR) Retired Staff

    Messages:
    11,992
    SteamRep Admin:
    STEAM_0:0:89705646
    Introduction:
    This guide is to explain how to create a guide.

    Please keep in mind a couple things when creating a guide.
    1. Make the title/subject very clear and understanding what your guide is about in a short line. There is no use in using very long sentences there.
    2. Make a introduction to what your guide is about, and explain what your guide will help with or help prevent.
    3. Keep the scope of the guide not too big, in general, people don't want to go thru 10 pages of text to find 1 part of it. If its that much to go thru, split it up in subjects and post multiple guides.
    4. Don't make wall's of text, break it up in paragraphs per part of the subject, explaining a point a bit to the needed understanding, but don't spend half your guide to one part of it.
    5. If you can use pictures, do it. If we like it, we can upload it to SR and make it a perm location where it can reside.
    6. At the end of the article, if you have used some resources (like some site's text that you in part used, or wiki, or w/e) make have some "resources" section. Where the readers can find more information regarding subjects.
    7. Make use of the BBCode, for highlighting your text where appropriate etc. But please don't make it a circus, the goal is to make it easy readable by the user, not to confuse him with all the possible fonts and sizes and huge pics etc.
    8. Once posted your guide, you can see in top right a button to "Watch Thread" click it and let it send emails to you if people reply to it etc. That way you dont have to keep checking the forums, you can get automatic emails.
    9. DON'T copy someone elses guide from somewhere else here. If that person wants his guide here, he's free to post it here. We also will not like it if others do this with guides posted here. The guide is property of the author, and we don't want other parties to just copy them.

    Rules:
    1. No direct linking to downloads.
    2. No covertly advertizing communities.


    Notes:
    Replies to your guides about errors should be addressed either in the guide's notes or adapting the guide itself. And then replying to the critique what has been adjusted etc. If the creator of the guide is not keeping it maintained, we may choose to start editing the guide by ourselves, or recreate one. In general we would wait a week after some issue keeps unanswered or some before doing such. People go on vacation, are not every day on our forum etc.
    Keep it civilized please, the guide topics are to help people, not to flame-war.


    Introduction:

    <Step by step guide itself.>

    Notes:

    Resources:
    David is human likes this.
  2. David is human

    David is human New User

    Messages:
    3
    Steam:
    STEAM_0:0:40752321
    Always love a well written guide for creating a guide. :D