How to format your suggestions

Infernus · Post by **Infernus** » 10 Mar 2016, 11:44

Introduction:
The amount of poor and eye blinding formatting is overwhelming the forums. Seriously. I'm not sure if that is because you are just lazy or actually don't know how to use it.

This guide will help you understand the proper way to format your suggestion to make it look simple, cool and sexy.
It also explains what to type in each section to make it easier to comprehend without reading too much redundant information, and easier for devs to see your way of implementation.

At the end, I wrote some premade formats for you to use. Simply copy and paste it in your thread.

Let's start:
First things first. Did someone already stole suggest your idea?
Open the search bar and search for the word that will most likely be already suggested (If you are suggesting something about flamethrower, search for "flamethrower").

If you can't find anything similar, open the first page of suggestions and check if there is a similar thread there (I once saw 3 bug reports, with the same name, one after another on the first page...) . If not, ask the guys in shoutbox if someone already suggested it. If no one replies, go for it.

If that suggestion already exists, bump it and explain why your suggestion would be better/would not suck.

The Format Re-Sexinator:
Now we make the format sexy!

This is the default format you get when you make a new thread:

As most of you can't see, it is as ugly as you are needs some tweaking.

► Show Spoiler

Summary (a quick, 2-3 sentence summary):

Benefits (How this will benefit the server and game as a whole):

Details (Description of how you think this would work, the benefits, etc):

Implementation (Optional, if you have an idea how to implement it):

First, let's remove some unwanted data to shorten it and figure out where to start typing from.

► Show Spoiler

See? Simple and sexier. There is nothing worse than starting on the same line as the format, or even worse, starting before the HTML code stops underlining.

Summary:
Your text here

Benefits:
Your text here

Details:
Your text here

Implementation:
Your text here

Now that we have made the format itself readable, we need to make it look like it wasn't made by throwing shit at it!
Colors! Yesssss, they are sexy. I always prefer very light blue or very light green. Different colored text and different colored underline is also a plus.
Here are some good examples:
Summary: color=#80BFFF
Summary: color=#80FF80
Summary: color=#8080FF
Summary: color=#FFFF80

Different colored lines: (For some strange reason, it only works with white lines on this forums, it breaks if you try to add another color)

Code: Select all

[u][b][color=#80BFFF]Summary:[/color][/b][/u]

Summary:

Sections!

I included some good examples of properly filled sections, don't be afraid to check them.

► Show Spoiler

Summary:
Your suggestion in max 3 sentences. If you can't sum it, you don't know what you are suggesting or your suggestion needs more tweaking/thinking as it is way too complicated.

Benefits:
Again, max 3 sentences to sum up how your suggestion will help the server/community. Remember, this is also a summary, so as less details as possible, just the key things your suggestion will bring.

Details:
Now this is where you explain your suggestion and details of your benefits. It must properly address everything you said in summary and benefits sections. This is not the place to talk about details how it should be implemented. (You can mention it here if absolutely necessary with as less details as possible, but try to save it for the next section)

This section will probably be the biggest one, so remember to cut it in paragraphs to make it easier. A blob of 20 sentences will discourage people from reading it. Each 4 or so sentences, press enter twice to make a gap and start typing again. Try to make so each paragraph has it's own meaning, like first one for first benefit, second paragraph for second benefit, etc...

Implementation:
"Code" <------- If you write this, you deserve to die...
You don't have to be a genius or a coder to fill this section (But it helps). The logical part goes here. The better you explain it how it might work, the easier it is for developer to see if and how will it be implemented via code. Check the examples and you will notice that there is almost nothing code-related inside, only logic behind how it would work. Think god dammit, use examples from other mechanics in the game.

If you are suggesting new icons, link some concept art or examples of how it could look like. It makes it easier for us.

Notes:
This is the right place to tell them to read it again before they post, as most of them just skim over it and shit your suggestion because they are lazy. You can also explain the purpose of this suggestion to make sure they don't misunderstand what you mean (Which happens a lot).

If your suggestion is short and there is nothing to fill up in one of those sections, if it is already explained in the title or some other section, or you simply don't know what to type in Implementation section, remove that section! It is redundant, there is no point of it to exist in your thread.

Things to avoid:
Massive, moving, glowing or underlining the whole text, starting at the same line as the section, leaving blank sections or having them contain redundant or retarded data (Implementation:"Coding" What-The-Fuck?). Dark colors, Same colored section and text below it (text should be brighter than the section color), default format, etc...

Examples:
You can use some premade examples I made. Simply copy it from the code box and paste it in your suggestion.
Thanks for reading! Enjoy!

I.

► Show Spoiler