This is a work in progress. The User Experience Guidelines exist as an effort to establish basic consistencies across TechNet Wiki. The guidelines are manual (you have to make the changes yourself),
and a goal of creating manual guidelines is to eventually turn some of them into automatic guidelines (that occur automatically through tools) in order to reduce editing and communication around following the guidelines.
In this article:
The title of the article determines the URL of the article. For example, an article is titled "Wiki: Style Guide", which results in a URL of
http://social.technet.microsoft.com/wiki/contents/articles/wiki-style-guide.aspx. Note that spaces become '-' and characters such as ':' are ignored when creating the URL for an article.
For more details, see the
Wiki Title Guidelines.
↑ Return to Top
Although all these guidelines should be followed, the highest priorities are the font type, font size, and to stick with a form of black color throughout the article. These three guidelines are important because they impact the
cohesiveness, branding, and consistency of the look and feel of TechNet Wiki.
12-point font size
Use the following black color: #262626
Use black throughout the article, including section headers.
Use Courier New, 11px
Capitalize the first letters of the name of a dialog box or window.
Capitalize the first letters of text as it appears in the user interface (UI).
Use all caps on NOTE and EXAMPLE.
Use italics for emphasis.
Use bold on UI terms only (text as it appears in the product's interface).
Use bold on NOTE.
NOTE: Do not format your hard drive.
Do not use on headers, EXAMPLE, or NOTE.
Use all caps. For example:
Use a colon after it and not a dash.
If you have more than one note, use "NOTES:" and then include a bulleted list below it.
Use smaller images so that smart phone users can see them.
You can upload a larger image and then resize it to a smaller size.
↑ Return to Top
This article is based on information from Daniel Klepner and
As Ana mentioned
in this blog post, Wikipedia has this to say about signatures: "When editing a page, main namespace articles should not be signed, because the article is a shared work, based on the contributions of many people, and one editor should not be singled out
above others." - Wikipedia: Signatures
The exception we make, is that we allow the Credits section (see "Credits Section" in "Layouts" above).
However, we want to give you credit for your work... We provide five ways for you to receive credit for your contributions in TechNet Wiki:
↑ Return to Top
Follow these guidelines in order to provide a complete story of Wiki navigation and accessibility. We might try to automate more of these features in the future in order to require less manual work and maintenance.
NOTE: This section includes only brief explanations. For full guidelines and details, see the appropriate bullets in the
Page Layout section above.
↑ Return to Top
To make an article easier to discover using the wiki search, include tags that are relevant to the topic discussed in your article. For example, an article that discusses using SQL Server Express with PHP should be tagged with the 'SQL', 'SQL Express',
and 'PHP' tags.
Divide each tag with a comma and a space. For example, "SQL, SQL Express, PHP, Needs Work"
When possible, use title casing, such as "Troubleshooting Guides".
Always use proper casing on product names, such as "SharePoint 2010".
Note that we know many tags have been "ruined" in the sense that the first person entered the casing incorrectly and we're now stuck with it. We have a feature request to update tag casing.
Try to limit the tags to one, two, or three words.
Use a space between words instead of putting them together. For example, use "Needs Work" instead of "needswork".
Because you divide tags by commas, you don't need to use quotes around multiple words.
Delete--Use this tag when you think an article should be deleted. Then contact Wiki administrators for discussion.
Needs Work--Use this tag when your article includes some information (so it is not a stub) but not enough to be a useful article.
Stub--Use this tag only (and no other tags) when no useful content exists.
Wiki--Use this tag when the article is about TechNet Wiki.
This section requires more information.
Perhaps change the "In this article" section to use the new [toc] tag?
Kevin, you can if you'd like. I haven't been doing that for articles that opted to do the manual TOCs.
Excellent Article Ed! Just what I'm looking for. :) pkn
Peter and I updated the TOC section and info. Thanks Peter!
Should we call this article "Wiki: Best Practices" instead?
I didn't know this article! And it's all here in one place!
All new Wiki contributors should read this article before its first contribution! I need to make some adjustments in my articles! ^^
If Portuguese articles no longer have the pt-BR tag, how do we find articles in this language?