Resources For IT Professionals
Post an article
Wikis - Page Details
  • First published by (eMicrosoft Partne)
  • When: 3 Sep 2013 6:59 AM
  • Last revision by
  • When: 13 Sep 2013 2:54 PM
  • Revisions: 34
  • Comments: 16
Options
RSSSubscribe to Article (RSS)
Can You Improve This Article?
Positively! Click Sign In to add the tip, solution, correction or comment that will help other users.

Report inappropriate content using these instructions.
Wiki  >  TechNet Articles  >  Wiki: Technical Editing

Wiki: Technical Editing

Wiki: Technical Editing

Table of Contents

This is a list of typical things that you can do right now, to get started helping out at TechNet Wiki.

List of Checks for Every TechNet Wiki Article

Please add the checks you normally do, so we can all work together for a better Wiki.
 

1. Tags

There are obviously thousands of tags in the Wiki. Here is a top list of the most common and important tags you can check for:

 

2. Content

  • Article title in "Title case" (e. g. not all CAPS)
  • Spelling and grammar
  • Enhance the "See Also" section
  • Tidy formatting, like paragraphs and proper headings

 

3. Layout

  • Add Table of Contents marker ([TOC]), when needed (the article has enough body and structure)
  • Add a See Also section
  • Use proper casing (NOT ALL CAPS) for
    • titles
    • headers
    • tags  
  • Use default fonts, colors and layout as much as possible (to keep consistency)


4. HTML

  • Check HTML tags (like nested or deformed header tags) and other broken/useless HTML
  • Check Code section - it is better to use Code block button with appropriate language
  • Check correct RGB color names (not values) are used - this is for Advanced Editors
  • Make sure the header <a name=> tags don't include the number "0" (zero). If the header includes the "0" number, then the <a name=> script includes the zero and then the header doesn't appear in the TOC. So just remove the "0" from the <a name=> script. For example, change "<a name=SQL_Server_2008></a>" to "<a name=SQL_Server_8></a>" instead.

 

5. Improvements

       
  • Any additional content that advances the article
  • Links to other articles, especially in the See Also section
  • Comments on the article - encouragement, congratulations, questions or criticisms

See Also

This article is featured in the WiKi Ninja blog Wiki Life: Technical Editing
, , , , , , , [Edit tags]
Leave a Comment
  • Please add 1 and 8 and type the answer here:
  • Post
Wiki - Revision Comment List(Revision Comment)
Sort by: Published Date | Most Recent | Most Useful
Comments
  • 13 Sep 2013 2:54 PM

    Maheshkumar S Tiwari edited Revision 32. Comment: Hi Naomi, I have seen many articles base on questions and answers. So how about tags like has questions,has answers

  • 13 Sep 2013 9:26 AM

    Maheshkumar S Tiwari edited Revision 30. Comment: Added link in See also: Wiki: List of Articles for TechNet Wiki

  • 12 Sep 2013 9:54 AM

    Naomi  N edited Revision 29. Comment: Added extra links

  • 10 Sep 2013 1:46 PM

    Maheshkumar S Tiwari edited Revision 25. Comment: minor edit. Hi Naomi , how about adding <hr> around See Also(can you consider adding it also) and a tag "has link,has links: for articles which have links""

  • 6 Sep 2013 6:49 PM

    Ed Price - MSFT edited Revision 24. Comment: Added the 4th bullet to the 4. HTML section.

  • 4 Sep 2013 10:31 AM

    Maheshkumar S Tiwari edited Revision 23. Comment: minor edit. Very informative , will bookmark it

  • 3 Sep 2013 8:13 AM

    XAML guy edited Revision 6. Comment: tidied tags and added links

  • 3 Sep 2013 8:00 AM

    XAML guy edited Revision 5. Comment: tidy

  • 3 Sep 2013 7:57 AM

    XAML guy edited Revision 4. Comment: changed around a bit and added list section and toc

Page 1 of 1 (9 items)
Wikis - Comment List
Sort by: Published Date | Most Recent | Most Useful
Posting comments is temporarily disabled until 10:00am PST on Saturday, December 14th. Thank you for your patience.
Comments
  • Posted by
    on 3 Sep 2013 7:57 AM

    XAML guy edited Revision 4. Comment: changed around a bit and added list section and toc

  • Posted by
    on 3 Sep 2013 8:00 AM

    XAML guy edited Revision 5. Comment: tidy

  • Posted by
    on 3 Sep 2013 8:13 AM

    XAML guy edited Revision 6. Comment: tidied tags and added links

  • Posted by
    on 4 Sep 2013 10:31 AM

    Maheshkumar S Tiwari edited Revision 23. Comment: minor edit. Very informative , will bookmark it

  • Posted by
    on 4 Sep 2013 10:35 AM

    Must see article for new editors... Thanks for writing it!!!!!!!!!!!

  • Posted by
    on 6 Sep 2013 6:49 PM

    Ed Price - MSFT edited Revision 24. Comment: Added the 4th bullet to the 4. HTML section.

  • Posted by
    on 10 Sep 2013 1:46 PM

    Maheshkumar S Tiwari edited Revision 25. Comment: minor edit. Hi Naomi , how about adding <hr> around See Also(can you consider adding it also) and a tag "has link,has links: for articles which have links""

  • Posted by
    on 10 Sep 2013 8:49 PM

    We discussed the question of tags in the Council and decided to use singular. So, even if article has several comments, the tag will be 'has comment' and even for several images the tag will be 'has image'. I'll discuss 'has links' tag separately. But for the two common tags has image, has table, has comment - use singular. The See Also should be separated by horizontal line. However, don't make these edits only - make other edits as well. In other words, don't try to perfect every article in very little detail - try doing changes in mass (few edits at once).

  • Posted by
    on 11 Sep 2013 9:28 AM

    Great article! This guidance is much needed and important.

  • Posted by
    on 11 Sep 2013 10:52 AM

    It is exactly what I am looking for.

    Thanks so much!

  • Posted by
    on 11 Sep 2013 12:08 PM

    Naomi added this to the Guidelines Portal: social.technet.microsoft.com/.../compare.aspx

  • Posted by
    on 12 Sep 2013 9:54 AM

    Naomi  N edited Revision 29. Comment: Added extra links

  • Posted by
    on 13 Sep 2013 9:26 AM

    Maheshkumar S Tiwari edited Revision 30. Comment: Added link in See also: Wiki: List of Articles for TechNet Wiki

  • Posted by
    on 13 Sep 2013 2:54 PM

    Maheshkumar S Tiwari edited Revision 32. Comment: Hi Naomi, I have seen many articles base on questions and answers. So how about tags like has questions,has answers

  • Posted by
    on 13 Sep 2013 3:20 PM

    We may want to have a separate discussion or a WiKi article on Tags. For now, in our recent Council chat we decided to not use 'has links' tag at all and use singular for 'has image' and 'has comment'. That's all we know for now. If you come across an article you want to edit, you may keep this in mind. But don't go for these changes only, we plan to standardize the tags at some point.

Page 1 of 2 (16 items) 12