Updating this manual

Introduction

A general guide and notes on how to add and style content in this user manual using Confluence.

Here are a few pointers to maintaining a consistent style:

Use Heading 2 as the top level of headings within a page (Heading 1 looks too much like the page title).
Use other heading levels in a hierarchical fashion.
By default, body text shouldn’t be numbered or in bullets. Use bullets for a list of things and use numbers for a sequential list (e.g. a series of steps that the user is to take).
Use panels to call out specific information (type “/info”, “/error”, “/warning”, “/note”, “/success” to create them).
Use expandable panels sparingly (type “/expand”) and, if used, make sure the heading/text that is always visible clear indicates what the expanded content will relate to (e.g. avoid “more information” etc.).
Use bold to highlight menu items and buttons referred to on pages, e.g. Document menu > Edit as XML.
Refer to the different screens within Lawmaker using consistent terminology (no quote marks required): Dashboard, Project tab, Amendment Workspace tab, Amendment Manager tab, Official Lists tab, the Editor.
Use “/children” to insert lists of child pages to create mini tables of contents wherever appropriate.
Avoid blank pages that just exist as a parent of child pages. Add a list of child pages at least but consider also adding some general text that is appropriate to the whole section.
Avoid very short pages (where possible) and keep related material together.

You can use the following labels to indicate the status of pages as we transfer content across from the old site:

Revise - Page has been converted to new format but hasn’t been updated
WIP - Page is currently being revised
Review - Page has been revised but would benefit from being reviewed
NotStarted - A page has been created with a header, but no or little content added

If there is a page that you do not want to be included in the website, add the following label (this will apply to any child pages as well):