Template

From Open Risk Manual

Risk Manual Template (Version 1.4 - Sep 2018). Use this text as a guidance when generating new articles (it might be easiest to copy the content on a separate file in your editing environment)

Suggested Section: Definition

This special section should always be present for articles of type "Definition" (which is the majority of Entry Types). It comprises of at least a sentence or two that defines the topic of the article. In case of synonyms it is useful to include a parenthesis the alternatives, as follows: (Also: AlternateName1, AlternateName2). Use bold typeface to highlight the key term.

Further Sections

The main body of the article (when the definition section is not sufficient) is organized within sections. Common sections headings (the list is illustrative, actual selection depends on topic):

  • Context
  • Use Cases / Applications
  • Formula / Calculation / Details
  • Advantages / Disadvantages
  • Alternatives

Subsections

Large sections should be split into subsections for readability. Avoid too granular a split as this creates a poor visual result

Key Section: Issues and Challenges

This special section should always be present (unless really not meaningful for a certain article type). The objective is to systematically highlight and make transparent the many difficulties around successful risk management

Using Advanced Features

The wiki supports and number of more advanced features for Authors that want to explore content creation beyond text based

See Also

Optional section with internal or external links. External Links should follow an number of rules:

  • abide by the Open Risk terms of conditions of use
  • be in English
  • be reliable sources


For example:

Categories

At the end of the entry, include all applicable categories to which the article belongs. Correct categories help discover the content when using the various category browsers. There is no unique or correct categorization scheme - it will always be in flux. The formatting of categories is done automatically. Simply include the markup as per example:

Reference Section

A list of references[1] (academic / other publications)

  1. I love referencing myself