Valve Developer Community:Style guide: Difference between revisions

Revision as of 02:48, 16 June 2023

This is a draft valve developer community page. It is a work in progress open to editing by anyone.
Remember to check for any notes left by the tagger at this article's talk page.

Stub

This article or section is a stub. You can help by expanding it.

This article details the conventions concerning the styling of pages on the Valve Developer Community. Considering that people have their own writing styles, and that they learn differently from each other, then that means there will be noticeable opposition in terms of opinions, quality of articles, and cooperation.

This guide should hopefully aid in dispelling that notion, and therefore standardizing a consistent style of writing and formatting throughout the wiki. However, covering all situations concerning styling would take an extended period of time, and as such the following content is only meant to act as a reference for Valve Developer Community specific content.

For a more advanced style guide, see Wikipedia:Manual of Style.

Article titles

The titles of an article should be short, sweet but not too long. As a general rule of thumb, the starting character of each world in a page title should be capitalized, and the following characters should be lowercase. This isn't a necessity, and there may be exceptions to this rule, but doing it this way helps maintain consistency.

On another note, redundant or superfluous wording, such as "most important", "correct" or "absolutely" should be avoided, as should the use of pronunciation marks, as they superficially inflate the importance of an article.

Also keep in mind that an article should cover one topic only, and it should do that well. An article should not cover various subjects or topics, as doing so would most likely obfuscate any information.

Here are some examples of good titles:

Hammer Editor
Source
Steam Deck
Team Fortress 2
Lighting

And here are some examples of bad titles:

How to create your first Hammer Editor map properly! ("properly" is superfluous and opinionated)
My favorite games
Baked lighting - guide and comparison to engine lighting
Why I love the source engine
List of noteworthy character quotes

As an exception to the above, user namespace pages may be named as you see fit, just as long as the names for the pages aren't vulgar, offensive or juvenile. E.g: User:Example/My guide to cubemaps (Completely acceptable pagename).

Wording