Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

  • In this page we would like to share some ideas how to write an article.
  • We are aware of the fact that most articles in this site currently wouldn't match these requirements. 
  • Let's put it like this: there is always room for improvement and the following chapters are intended as a guideline for constant improvement towards a better knowledge base.

Before you start writing

Find out about existing standards

...

  • if you want to publish a solution that you found then don't forget to mention the problem that you solved.

Define the scope

After

...

writing

Have someone review your article

  • It is always a good idea to have someone review your article.
  • Receiving a second opinion might help to discover aspects of topic that were out of your radar.
    • Use the share operation that is available on every page to invite other users for review.

Publish your article

Accept feedback

  • This site provides some mechanism for ratings and surveys.
  • Feedback is not necessarily about receiving applause. Never take a negative feedback personal and never discuss with posters.
    • Feedback presents someone's perception of an article and therefore is neither right nor wrong. 
    • Instead, try to understand what problem has been perceived and if you could accept to modify your article to comply with the poster's perception.

Never stop improving

  • So you think you're done having received some feedback on your article? Definitely not.
  • Articles tend to become inaccurate and even obsolete by ageing. 

 

 x