This is topic contains proposed templates for the TechNet Wiki. 

These are the different templates on this page:

 


Field / Survival Guide

A field or survival guide is simply a collection of links to different resources across the Internet.

Description of the area the guide will cover and, if needed, the areas that should not be included. Examples include Hyper-V Survival Guide, PowerPivot: DAX Survival Guide, ex3.

Optional: Links by Technology

  • Link1
  • ...

Optional: Links by Task

Optional: Content Type (video, twitter, blog, podcast, tools)

Optional: Related Products and Technology

References

Credit original sources and other material.  This can increase the trust of your article as well as provide additional help/information for curious readers.

  • Reference one with URL and brief description of what was useful/why it is a reference.
  • Another reference

Tag this as a "howto" in addition to tags indicating major technology area and problem. See Common Tags and the Tag Cloud for tag ideas.


Reference

 


How-To

A how-to topic describes the steps required to solve a particular problem.

(Your title should include "how to" and concisely describe what problem the article will address. For example: How To Use PowerPivot to Export Widgets.)

Description of the problem you are solving in this article. Great examples include ex1, ex2, ex3 (make sure these links are set to open in NEW window).

Title of the How-To

In this section, give a brief overview of the steps. If there is a sequence, list it out.

  1. Step 1
  2. Step 2
  3. Step 3
  4. Done

Provide additional notes and supporting information here or in separate sections, if necessary.

References

Credit original sources and other material.  This can increase the trust of your article as well as provide additional help/information for curious readers.

  • Reference one with URL and brief description of what was useful/why it is a reference.
  • Another reference.

Tag this as a "howto" in addition to tags indicating major technology area and problem. See Common Tags and the Tag Cloud for tag ideas.


Sample

 


Troubleshooting

A troubleshooting topic contains multiple problem/cause/resolution sections.  You create a troubleshooting article with one problem/cause/solution.

Description of the product(s), technology(s) addressed. Great examples include ex1, ex2, ex3 (make sure these links are set to open in NEW window).

Problem1

Optional: Cause1

Resolution/Work Around/Recommendation

Optional: For More Information

References


Overview/Portal (wiki-only links)

Overview of a technology with links to key TechNet Wiki topics in this area/technology. (External guides. tools, sites, and other information fo into Field and Survival Guides). Essentially this is a TOC replacement. The overview could merely be a short section where the focus is on the links (example: SQL Server Overview), or it can be a larger section, with the links at the bottom (example: PowerPivot Overview).

Description of the product(s), technology(s) addressed.

Topic Wiki Pages

These are the Wiki links for that technology, product or topic. For the PowerPivot Overview, this section is titled PowerPivot Wiki Pages. The links are listed as bullets:

  • Link 1
  • Parent Topic Link
  • Child Link 1
  • Child Link 2

If the product includes video-based articles, include links to those topics under the sub-section, Videos.

For example:

TechNet Library (optional)

Or name it MSDN Library if the Help topics are on MSDN. This section is optional. Then divide the lists by type of content, such as Help Documentation, White Papers, Videos, and Diagrams/Posters.

For example:

Help Documentation

White Papers  

Diagrams and Posters

Community Resources

Next, include a section that lists external, non-Library sources. Essentially, this is a miniature Survival Guide. If a lot of links are in this section, pull them out and create the separate Survival Guide (but you might want to leave the top sources here as well).

Include sections such as Official Sites, Community Blogs and Sites, Books, and Videos.

For example:

Official Sites

Community Blogs and Sites

Books

Videos

See Also

Include this section at the bottom to point to other TechNet Wiki articles that are related but wouldn't belong in this product's TOC.


Portal (wiki-only links)

The Portal is similar to the Overview/Portal, but the key difference is that the focus is on the TOC of the product/technology, and the overview information is on another page. Essentially, use this model when the Overview and the Portal sections of your technology are both too big to be on one page. Make sure to link the pages together.

Good examples include the Wiki Platforms Portal, and the Hyper-V Portal.


Conceptual 

 


What’s New

 


Error Message Text and Number or Event ID Number and Source

Applies to

Error Details or Event Details

Diagnostic

steps (if applicable)

Resolution

References