Developer's Blog

Remember me ?             Register


       
Notable Example Guides
Quality Content + Conciseness + Good Visual Formatting

- Zeus - by Merlini - Concise + full of short nuggets style - notice item descriptions are extremely concise)
- Beast Master - by Ramomar - (visual clarity + good color coding contrast + unique style of item notes color matching the icon color)
- Comprehensive Dota Gameplay Guide by Niss3 - (style of color coding choice)

Specific Highlights

- Slardar - by EcceLex - extra info chart
- Hookless Tank Pudge - by kalorful - "unique style"
- Ursa - by Elune - nqb's (non-quote boxes) neatness
- Enigma - by Vindicate Has lots of spoiler tags, as close to the limit as you should ever get, but good content
- Viper - by gwho - (anchor usage other than Table of Contents)
- - simply linking to other sources for extra info)
Templates
Ramomar's Guide Template 1

Ramomar's Guide Template 2


Aequinox's Hero Template



For feedback on a guide you are drafting atm, post here for feedback from the Guide Writing Guild
http://www.playdota.com/forums/group...le-easy-acces/
BB Code Tutorials
BB Code Reference Page.
- Upper case / lower case is not discriminated.
-

Useful Codes:
Incorporating Images


[IMG]http://www.playdota.com/img/hero/16/skill-0.gif[/IMG]


- Take the images address (aka URL) and put the "IMG" tags around it.
- If your picture is on your computer, upload it to your albums, and it will create a url for that image.
1) Go to your profile
2) Go to Albums
3) Create an album/upload image, by clicking browse and finding your image.
4) Once you click ok/submit a page of your images with the URL as well as URL with IMG tags already around it should appear.
- To get icons from playdota.com's Hero and Item Database, right click the image, and select "copoy image address".
- For small icons right click the icon directly. Large icons can be obtained after you normal click the small icon and then right clicking the large icon that shows up.


Spoiler

Hidden

[spoiler]Hidden[/spoiler]


Hyperlinks

DotA Forums
[url=http://www.playdota.com/forums]DotA Forums[/url]


Youtube
- Copy and paste the provided code from the youtube page under "embed" and put tags around it
- You can also just enter the portion of the link after the "=" sign instead of copy-pasting the imbed code



[YOUTUBE]
<object width="425" height="344"><param name="movie" value="http://www.youtube.com/v/Rook-MzIAX0&hl=en&fs=1&"></param><param name="allowFullScreen" value="true"></param><param name="allowscriptaccess" value="always"></param><embed src="http://www.youtube.com/v/Rook-MzIAX0&hl=en&fs=1&" type="application/x-shockwave-flash" allowscriptaccess="always" allowfullscreen="true" width="425" height="344"></embed></object>
[/YOUTUBE]


The Not so Well-Known Codes:

Anchor

clickable text
destination

[goanchor=value] clickable text [/goanchor]
[COLOR="Lime"][U] [anchor=destination] value [/anchor] [/U][/COLOR]

- clicking an anchor correctly coded will result in taking you to the denoted portion of the page.
- the "value" for the goanchor/anchor can be letters or numbers or combinations, but must be "one word", meaning it cannot contain spaces.
- each goanchor/anchor pair must share the same "value"
- in the goanchor portion, the visible clickable text is between code brackets.
But in the anchor portion, the visible text comes after the "=" sign within the brackets. The "value" is in between the brackets (strange, I know, but it won't function otherwise)
- To apply color/font/bold on the destination text, treat the entire bracket pair (anchor to /anchor) as the text, and apply codes around the entire "anchor to /anchor" pair.


Non-Quote Box

Text in a Non-Quote Box

[nqb]Text in a Non-Quote Box[/nqb]

- Non-quote boxes give you the box, without the words "Quote:" on top of it like a quote box would.
- Also, it allows people to quote the content of the quote box, something in quote box is not quoteable by other people (clicking the "quote" button in a forum thread or PM)


NoParse

[FONT="Century Gothic"][SIZE="4"][b]text is NOT affected by codes[/b][/SIZE][/FONT]

- This code is useful for sharing with others your coding.

[noparse] [FONT="Century Gothic"][SIZE="4"][b]text is NOT affected by codes[/b][/SIZE][/FONT] [/noparse]


Php
HTML

-these commands will do the same thing as noparse, but for only that type of code, instead of the universal "noparse" command.


Table


Torrent - (Active, AoE-Target, Affects Enemy Heroes)
____________________Using his unparalleled knowledge of the sea, Kunkka is able to summon a blast of water at a targeted area. After 2 seconds a fierce torrent of water erupts from the ground, the stream blasting enemies caught in the AoE into the sky, dealing damage and slowing movement speed by 30%.

______.________._______.___._______.__________________________.
 ManaCooldownC. RangeAoEDurationEffects
112012 sec15002251 sec120 damage, 30% slow
212012 sec15002252 sec180 damage, 30% slow
312012 sec15002253 sec240 damage, 30% slow
412012 sec15002254 sec300 damage, 30% slow
[img]http://www.playdota.com/img/site/sk.gif[/img][indent][B][COLOR="lightblue"]Torr[u]e[/u]nt[/COLOR][/B] - (Active, AoE-Target, Affects Enemy Heroes)
[table][COLOR="black"]__________[/COLOR][img]http://www.playdota.com/img/hero/66/skill-0.gif[/img][COLOR="black"]__________[/COLOR]|Using his unparalleled knowledge of the sea, Kunkka is able to summon a blast of water at a targeted area. After 2 seconds a fierce torrent of water erupts from the ground, the stream blasting enemies caught in the AoE into the sky, dealing damage and slowing movement speed by 30%.[/table]

[img]http://www.playdota.com/img/site/stable.jpg[/img]
[table][COLOR="Black"]__[/COLOR]|[COLOR="Black"]____.[/COLOR]|[COLOR="Black"]________.[/color]|[COLOR="Black"]_______.[/color]|[COLOR="Black"]___.[/COLOR]|[COLOR="Black"]_______.[/COLOR]|[COLOR="Black"]__________________________.[/color]
|[COLOR="lightblue"]Mana[/color]|[COLOR="lightblue"]Cooldown[/color]|[COLOR="lightblue"]C. Range[/color]|[COLOR="lightblue"]AoE[/color]|[COLOR="lightblue"]Duration[/color]|[COLOR="lightblue"]Effects[/color]
[COLOR="Orange"]1[/COLOR]|120|12 sec|1500|225|1 sec|120 damage, 30% slow
[COLOR="Orange"]2[/COLOR]|120|12 sec|1500|225|2 sec|180 damage, 30% slow
[COLOR="Orange"]3[/COLOR]|120|12 sec|1500|225|3 sec|240 damage, 30% slow
[COLOR="Orange"]4[/COLOR]|120|12 sec|1500|225|4 sec|300 damage, 30% slow[/table]



text text text
text text text
[table] chart [/table]

[noparse] [table] text | text | text
text | text | text | text [/table]
[noparse][table] chart [/table]


List
  • text
  • text
[List][*] text[*] text[/List]

  1. text
  2. text
[List=1][*] text[*] text[/List]

  1. text
  2. text
[List=A][*] text[*] text[/List]

  1. text
  2. text
[List=a][*] text[*] text[/List]

  1. text
  2. text
[List=I][*] text[*] text[/List]


Basic Text Related Codes:
Underlining with a Color Different Text

text

[COLOR="Red"][U][COLOR="DeepSkyBlue"] text [/COLOR][/U][/COLOR]


Text Alignment

left
middle
right
this text is indented
[left]left[/left]
[center]middle[/center]
[right]right[/right][indent]this text is indented[/indent]


Color

Red
[COLOR="Red"]Red[/COLOR]
OR
[COLOR="#ff0000"]Red[/COLOR]

-you do not necessarily need the quotation marks around the color name
-hexadecimal (6 character) codes allow for the entire spectrum of colors
-hexadecimal codes must follow a "#"
Here is a link where you can see some color codes.


Underline

Text is Underlined
[U]Text is Underlined[/U]


Strikethrough

Text is crossed
[S]Text is crossed[/S]


Bold

Text getting fatter
[B]Text getting fatter[/B]


Italic

Text is Italic
[I]Text is Italic[/I]


Font

Hi I'm a different front
[FONT=impact]Hi I'm a different front[/FONT]


Size
I'm larger
[SIZE=+4]I'm larger[/SIZE]
Type of Guide
Misc. Guides:

Hero Guides:
  • comprehensive
  • mini
  • concise, full of "short nuggets"

The last is probably the most popular and favored guide style, as it makes it easy on the reader, while being able to learn a lot of good information quickly to put into practical use.

Even comprehensive guides should aim to sift out superfluous wording. The purpose of a comprehensive guide is to touch upon everything in the level detail required, not to fill up X number of words for an essay, or give the reader practice material for speed reading.
Basic Contained info:
Skill Build
Item Build
Strategy
Hero Relationships: good allies, worst enemies
Key Notes/tips/strategy
Going Beyond:
Going beyond

Intro
Strenghts and Weaknesses
Role or the hero
Stats/ Stat gain analysis
Brief mention of history of tweaks and balances
Screenshots
Video clips
Additional relevant information (charts of armor, link to orbwalking, orb stacking, image properties, etc)
Anchors
Replays
To Copy Skill/Stats/Background Info or not to Copy?
Playdota.com has the full information on heroes listed so it is not necessary. But some find it convenient to have on one page and like to comment on each skill for usage.
The best middle-ground solution would be to include it in a spoiler tag.

Arguments for not copying
  • Playdota.com has the full information anyways - There is a link on the top right for every guide so you don't even have to link it in the guide itself at all!
  • Makes your guide long, and fills it with "fluff" - Make it more "complete" in other respects.
  • "It's more convenient to have the basic hero info in another tab"
Arguments for Copying
  • If the guide is exported to a different site, the info is available for them as well. (But honestly, you can just provide links to the playdota.com page)
  • Makes the guide seem more "complete"
  • I want to comment on each skill and would like to keep the format
  • "It's more convenient to have the basic hero info on the same page"
( My bias kind of shows on the lists, but, oh well =] )
Visual Formatting
The tools of the trade is BB Code usage. See the next section.

THE MOST IMPORTANT THING

What REALLY gets ppl loving your guide:
It comes down to Ease of Reading.
This means conciseness, with a lot of good info. Little work in reading, but a lot gained from it. (see zeus, rexxar and puck guides)
screenshots (also concise. use video clips instead of sequences of screenshots if you can't deliver the point in one screenshot)
- Color selection: contrast (bright, dark)
(usu headings, subheadings, interjections, color coding
(theme matching)
- Uniformity - Maintain it throughout the guide in:
  • spacing between lines and headings, and after dashes
  • Grammar, spelling, person number usage
  • Colors selection for headings
  • Indentation

How to Format Skill Builds


The Correct Way:
List out each level and occurrence of the skill, rather than grouping them up (see 3rd example)
- Color code the skills

Level 1 - Poison Attack 1
Level 2 - Nethertoxin 1
Level 3 - Poison Attack 2 / Nethertoxin 2
Level 4 - Nethertoxin 2 / Poison Attack 2
Level 5 - Poison Attack 3
Level 6 - Viper Strike
Level 7 - Nethertoxin 3
Level 8 - Nethertoxin 4
Level 9 - Poison Attack 4 / Corrosive Skin / Stats
Level 10 - Poison Attack 4 / Corrosive Skin / Stats
Level 11 - Viper Strike
Level 12 - Corrosive Skin / Stats
Level 13 - Corrosive Skin / Stats
Level 14 - Corrosive Skin / Stats
Level 15 - Corrosive Skin / Stats
Level 16 - Viper Strike
Level +17 - Stats

- Denoting the level of the skill is useful when listing alternate options (as in the case of level 3 and 4). When listing alternate options, the occurence of a skill becomes more than 4 and can be confusing.
- If it is a set build with no mid-way options listed, numbering isn't necessary because that will be denoted by the occurence.
- However, notice Corrosive Skin is not labeled with numbers (levels 9-10, 12-15) because there are too many combinations of takes. Even though stats is listed several times, noticed that Corrosive Skin ends at level 15. All this is saying is Corrosive Skin and Poison Attack should be maxed out by level 15, but feel free to take stats ONCE at any time between levels 9-15. But for more fixed, one-track skill builds, skill level denotation works nicely.
Listing Skills once and putting numbers for level after it
Poison Attack - 1,3/4,5,9
Nethertoxin - 2,4/3,7,8,
Corrosive Skin - 10,12,13,14
Viper Strike - 6,11,16
Stats - 15, 17-25

GUIDES ARE NOT SUDOKU PUZZLES! Even on miniguides, this is not acceptable. What is the first thing you did when you saw this formatting? I bet it was tracing 1...2...3.... This should tell you something: most people keep track of skills in order of level growth, not in terms of single skills at such and such level. This may be easier for you writing the guide, but if you were concerned about that, you wouldn't be writing the guide in the first place. Also note how using slashes for optional deviants makes it even more harder to follow.

Don't be a douche. Did you forget the silver rule of guide writing?
Quote:
What REALLY gets ppl loving your guide:
it comes down to ease of reading.
(the golden rule is quality content, dummy ^^)
Grouping Up Skill Builds.

Level 1 - Poison Attack
Level 2 - Nethertoxin
Level 3-4 - Poison Attack / Nethertoxin
Level 5 - Poison Attack
Level 6 - Viper Strike
Level 7-8 - Nethertoxin
Level 9 - Poison Attack
Level 10 - Corrosive Skin
Level 11 - Viper Strike
Level 12-14 - Corrosive Skin
Level 15 - Stats
Level 16 - Viper Strike
Level 17-25 - Stats

Not as bad as the the previous example.
- Contrary to belief, grouping up makes it harder to read, not easier.
- It is much more convenient for the reader to be able to count the occurences instead of reading if it is a group of 2, 3, or 4.
- The amount of lines saved by grouping is so insignificant. Cut space elsewhere if you're concerned about minimizing guide length.
- Grouping up the stats at the very end is fine, though.



Usage of Spoilers
Good Usage:
- detailed things that aren't necessary, but informative (long big charts, wall of text)
- overly long parts (tons of photos, walls of text)

Bad Usage:
- core info (skill builds, item builds)
- too little info in each spoiler (combine into larger chunks - clicking 1000 times is annoying)

*Important Note: Search function does not work within spoiler tags if it hasn't been openned.
When to Use Anchors
- Table of contents.
- references linking to other sections of the guide
Substance
Content

Don't write a guide that is only for -em (easy mode), or a guide that is basically "noobish" due to the fact that decent players will prevent a lot of the things in your guide from happening, or is dependent upon the abundance of gold that may not be available in non-em modes. You can certainly accomodate the non-competetive players, but people will be looking to your guide to get better, and approach the highest level possible. That is not to say that unless you are perfect in every respect, you should not write the guide.

Fun or unique builds are an exception however. In this case, Unique builds are hardly ever viable for competetive level, but worthy to be tried for fun, and aren't completely unviable. This is different, however from a guide that relies on easy mode and ignores most of the gameflow and realistic limitations in a bit more higher level play, even if that simply means competent pubs.

better to excel at an aspect than tryiing to cover everything to reinvent the wheel. (there are other existing guides, and what you bring to the table for that hero guide should be easy to pick out and not so redundant or fluff.


Development

Collaborate, discuss and ask for help from people to improve the information you present within your guide.

draw upon other guides for that hero/ subject, as well as other guides for other ideas:


Development / Editing
Writing is all about editing and improving. No masterpieces comes in one shot; no first draft becomes a best seller. one person said "i'm not a good writer; i'm just a good re-writer"
Miscellaneous
Don't forget to include a credits and thanks section
^^ people helped you along the way. you didn't come up with everything by yourself. Even if you somehow did, you still learned from others, by reading and discussing, and getting feedback on your guide. Don't be an ungrateful ass xp
Grammar, punctuation, consistent person usage.

Walls of text: how to break up. paragraphs, indentation, colors, pictures in between
Bought to You by:
gwho
&
Lycan
Eumellein
Guide-Writers





Misc guide
Author: gwho
Map Vers.: PlayDota

The Right Guide to Guide-Write

The Right Guide to Guide-Write

Date Posted: 08/05/09
Last Comment:17/05/2012
Total Votes: 54
Current Rating: 8.89
Views: 15319



Login to post a comment