Table of Contents

Introduction

At the TNWiki we strive to have a collection of high-quality articles.

As explained in the article "Wiki Governance: What Is Considered Quality Technical Content?", high quality means valuable content with

  • an introduction
  • an original solution
  • source code
  • images
  • reference material
  • good explanation
  • examples
  • How and what has been done in the article (or not)
  • good article structure

As explained in Wiki Governance: Types of Articles Not Appropriate for TechNet Wiki  (http://aka.ms/NotForTNWiki), you must avoid writing single line or one paragraph articles.

Few tips to write added-value articles

  1. Before writing the article kindly study deeply about the subject.  
  2. Give an Introduction about the Topic.
    1. Write why you have selected the topic and what you are going to explain in the topic.
  3. If prerequisites are needed give the link for download.
  4. If end users require some basic knowledge to understand your programs then give some reference link to end users. 
  5. If you provide code in the code part, remember this is a main part of the article.
    1. Always explain your program or sample step by step to the end user.
    2. Explain how to start the project and end with how to check the final output.
    3. Always add important code snippets and explain what you have done.
  6.  If you want to explain a simple solution or simple example then don’t end with one paragraph or within one solution. Always give detailed explanations and give different examples so the reader can understand the solution.
    • For example, imagine we selected the topic as C# Class and Object. Instead of explaining one simple Class and Object program.
    • First, start to explain what is C# OOP, then explain in detail about what is a Class and then explain what is an Object. Write two or more different examples for Class and Object and explain the code part in detail to the end user.
    • And also explain about the different types of Class in C# with details and a sample program with an explanation.
    • Another example is SQL Server: If you plan to write an article for a Join query. As mentioned above, first explain exactly what a Join is in SQL and what the available types of Join are.
    • In code part, first create sample tables which will be used for explaining our sample Join query. Insert a few sample records to the tables to be used for our Join query output. Explain each join in detail with one or more sample query.
  7. Conclusion: Always end your article with a conclusion and your future plan to improve the article.
  8. Add a See Also with reference links to other Wiki articles for members to study more details about your selected topics.
  9. Add a References section with links to third party platforms (external to Wiki).
  10. After writing your article, read it two to three times by yourself to proof the grammar.
  11. Ask you peers to review the article.
  12. After all these points are done and if you feel comfortable with what you have written, then publish your article.

Also check: Wiki: Collection of Practical hints & tips for writing an article (from Wiki blog)

Credits & Quotes

If you want to reuse text that already has been written by someone else, you must provide proper credits

  • where you got the text from (source reference)
  • who has written the content (owner)
  • when the content was written (date of publication)
  • indicate the part of the text referenced (quote)

It's illegal to copy content and present it as if you wrote it yourself. Pirated content will be removed form the Wiki.

For more information:

Checklist

Check: Wiki: Before you post your article - Quick check list

Guru Competition

In the monthly Wiki Guru competition, the judges will validate if the participants meet the quality bar. If the quality allows participation, medals will be given.

Judges are expected to provide a motivated explanation if an article fails the quality check.

See Also