Thursday Council Spotlight: Make your TN Wiki Article Concise and be in the Spotlight


Like any profession, becoming a TN Wiki contributor requires a certain set of skills and primarily writing and illustration.

Adding more technical jargon in an article doesn't make it richer or suffice for readers, instead an article should make readers understand the content and to follow the instructions.

Indeed, it's bit time consuming task for the first time TN Wiki author. But DON'T stop, practice makes things perfect and spending enough time on certain valuable things are precious which involves Sharing!

Come On, Join TN Wiki, Share and be in the Spotlight!

spotlight-550x352

Here is the top 6 most important points which may help to organize the TN Wiki content you wish to share as TN Wiki beginner!

  • Abstract
    • A short note which should attracts readers attention.
    • Keep it simple and clear.
  • Introduction
    • This is most read section in any of the article. So, include words only relevant to the technology or requirement.
    • Again, this stands a attention grabber. Try to avoid jargon!
  • Solution
    • Code, Design, Tools etc should be covered in very clear formats and add images if applicable.
    • High light the trick and nuances of the code or solution.
  • Results
    • Outcome of the solution.
    • Include images as applicable.
    • High light the expected result.
  • Conclusion
    • Place to warp your article content with few words
  • List of references
    • Include the links which you referred while coding or designing.
    • Don't include third party blog posts.

The Technical content we share in TN Wiki is to help people to solve operational issues specific to the technical product, to share your set of skill in the products, highlight the key features etc.

So, by following the above top 6 bullets we can get rewards from MSDN and be on Spotlight.

Yes, rewards are one of the most inspiring factors and this blog post gives more insight.

Any TechNet Wiki article published which is linear, precise and concise and with quality content will be showcased every Tuesday in TN Wiki Article Spotlight and yours could be one in near future!

Sharing is Caring!

TechNet Wiki Addict Chen V

TN Wiki Ninja

Comments (4)

  1. It’s interesting. I’ve seen both. I’ve seen articles that are long and hard to read and understand. But I’ve also seen articles that are only screen shots (with maybe one line between them) without explaining why something is happening, or what the goal is. Or what you even did in the screenshot.

    Likewise, I see articles that are one long code sample. Instead, it’s far more valuable to break up the code into smaller pieces and explain what each piece does. Then you can put the full sample on MSDN/TechNet Gallery and link to it from the Wiki article.

    So I see both sides… I do see long articles that could be shortened, but I also see a lot of articles that could use more content and more explanation of the details.

    Great topic. Thanks, Chen V!

    1. pituach says:

      Break up the code into smaller pieces and explain what each piece does, is a must. An article is not a code gallery. The article should explains what and how to do. If the article describes a project for example then *the author should add a link to download the project as one, or at least all the code*. This should not be in the article.

      Moreover, any developer that works with OOP languages like .Net, should understand that OOP does not come to make it run faster but to make it developing and maintenance faster&simpler. There is a role that lot of APP architect follows which say that a block of code not be more then 15 lines. A longer code should probably moved as a new element (method, properties, or even anew class). In these cases each block of code should be post in the article as one section with explanation. For the same reason authors should not post the entire class with 1k lines as one.

      * If you cannot split your code logically to blocks of code, then in lot of cases you should re-thinking not only about the article, but about your application architecture 🙂

  2. pituach says:

    I like the top 6 most important points. I think it is a good idea to mentioned these in any opportunities including in the monthly article, where people register to the monthly competition.

Skip to main content