PPDM Wiki Style Guide
This guide outlines how to edit/add information to the PPDM Wiki/Best Practices/F.A.Q.. The guide aims to create consistent and easy to read content.
Contents |
Titles/Headings
- Short and to the point
- The Database Version/table/column/process should be in the title for searching purposes
Content
- Written in 3rd person neutral
- Article should be unbiased, present the problem and solution clearly, stating any tables, columns, inter-table relationships involved.
Content styling
- Titles/Headings in bold, 2 font sizes larger than normal
- Details on how to format the wiki can be found here http://www.mediawiki.org/wiki/Help:Formatting
Abbreviations
Use the full name the first time you reference the abbreviation followed by the abbreviation in brackets: Public Petroleum Data Model (PPDM)
Date Format
YYYY / MON / DD Capture the month as characters (JAN instead of 01) because we don't have an international standard for dates that everyone follows. Is 06/11/2007 June 11 or November 6? It depends on who created the date. Spelling the month out eliminates the confusion.
ISO 8601 is the international standard for (all numeric) dates and times. See the Wiki entry at ISO_8601, or an excellent summary at ISO Time for more information. The standard for dates is YYYY-MM-DD.
PPDM Table Names
Pages have been created for every table in PPDM 3.8, and are named using the table name (in upper case). If you want to add information about a specific table, please use these pages, so that information about each table is consolodated into one location.
General Help
For general information about how to create and update wiki pages, please visit http://www.mediawiki.org/wiki/Help:Contents
