-
Notifications
You must be signed in to change notification settings - Fork 8
Style Guide
This is the style guide contains the best practices for the metanorma.org documentation. If you are not yet familiar with how the docs are structured, make sure to have a look at the Project documentation structure first. This page discusses:
WORK IN PROGRESS...
Who do we write for?
In general, there are four types of documentation on metanorma.org, see Project documentation structure. To increase consistency and predictability, the content types are standardized further, using content models. This helps readers scan the text and find what they need, quickly.
WORK IN PROGRESS
How-to guides consist of the following elements:
-
Title
-
Introductory paragraph/sentence stating why and what the user will do
-
Prerequisite (optional)
-
Steps
Intermediate results (optional)
-
Example (optional)
-
End result
-
Related links (optional)
Example document: How to add diagrams
Template: How to guide template
WORK IN PROGESS Template: Explanation template
WORK IN PROGESS