Why a Documentation Tab?

We introduced the documentation tab for the following reasons:
  • Consistency across Projects – The #1 feature request from the most dissatisfied users is the need for a consistent place to find documentation across projects.
  • Encourage writing of documentation – We’re hoping that a documentation tab will encourage project owners to write documentation, especially with the help of the Editor role.

What if I already have documentation on my wiki?

If you already had a wiki page titled “Documentation”, we’ve migrated this for you under the Documentation tab.

You can migrate other wiki pages to the Documentation tab by editing the page and clicking on the “move to documentation” link, once you have made your Documentation tab publicly visible (see more on that below). We will move any child pages and any attachments.

image002.png

How to show System Requirements?

The documentation page now has a section to display System Requirements on the right-hand side.

image004.png

Why do only some of the projects show a Documentation tab?

We felt it was important to clearly indicate whether a project is providing documentation under this tab. In the event that the project owner isn’t using this tab, we decided to hide the tab from the public. We want to avoid users visiting the documentation tab only to find no content.

What does the Documentation tab look like by default to project owners?

To encourage documentation writing, we indicate to the project owner that the Documentation tab is current hidden and provide suggestions on what should be included in this section.

image005.png

Last edited Apr 14, 2010 at 5:54 PM by CodePlexAdmin, version 3

Comments

Manu404 Feb 27 at 10:20 PM 
Same as Tom103. When will we be able to import the generated xml documentation based on the comments in the code ? :'(

daijinhui Jan 15 at 5:46 AM 
asd

johnmcalvert Jun 17, 2012 at 10:58 AM 
Would be helpful to have a template or have the default empty page come with a few suggested headings.

tom103 May 30, 2012 at 12:39 AM 
What about API reference? I have XML documentation comments in my code, can I import that to the wiki?

kajaldas007 Jul 19, 2011 at 4:47 PM 
how do I include a picture in the documentation tab by uploading the picture from my computer's hard drive?