Difference between revisions of "Help:Guidance for writing in Opasnet"

From Testiwiki
Jump to: navigation, search
(first draft based on own thinking)
 
(Added category: 'Help')
Line 16: Line 16:
 
* In case of meeting minutes, the group should have a page of its own. However a meeting agenda or minutes does not deserve a dedicated page, because it is such a minor issue. If these are written to the page of the group, all previous agendas and minutes can be retrieved from the history of the group, and direct links to the minutes can also be created.
 
* In case of meeting minutes, the group should have a page of its own. However a meeting agenda or minutes does not deserve a dedicated page, because it is such a minor issue. If these are written to the page of the group, all previous agendas and minutes can be retrieved from the history of the group, and direct links to the minutes can also be created.
 
* Avoid the use of word "baseline" in variable names. Because all variables are about truth, all variables are kind of baseline estimates.
 
* Avoid the use of word "baseline" in variable names. Because all variables are about truth, all variables are kind of baseline estimates.
 +
[[Category:Help]]

Revision as of 12:11, 6 April 2011



Guidance for writing in Opasnet gives guidance and practices for writing in Opasnet. Usually, writing is very similar to any other writing: be clear, stick to the topic, avoid complex terminology if possible. However, Opasnet is not just some Internet website. It is based on a set of rules that are specifically designed to improve the structure and usability of the information. Therefore, some practices in Opasnet are different to practices people are used today. As a very typical example, people are so used to sending Word documents via email to a dedicated group of people that they find it strange to write their information directly to a structured wiki system in the Internet for anyone interested.

Scope

What is a useful collection of guidance and practices for a person that wants to produce content to Opasnet according to the information structure and method of open assessment?

Result

  • Variable pages about exposure-response functions should have this format: ERF of <pollutant> on <health impact> in <population>.
    • In the first paragraph, the word ERF should be linked to page ERF.
  • Avoid the uploading of Word files if it is possible to write a wiki page about the topic instead.
  • In case of meeting minutes, the group should have a page of its own. However a meeting agenda or minutes does not deserve a dedicated page, because it is such a minor issue. If these are written to the page of the group, all previous agendas and minutes can be retrieved from the history of the group, and direct links to the minutes can also be created.
  • Avoid the use of word "baseline" in variable names. Because all variables are about truth, all variables are kind of baseline estimates.