Document Conventions

Content

The structure of the Help Documentation content at a high level generally follows the layout of tabs and panels in the Historion Software.

The Help Documentation covers all features and intentions of the software. For each feature the following six main topics are assessed and given consideration, to the  extent of the complexity and significance of the feature. Features are described using some or all of the categories below.

1.Background

Purpose and Radiation Safety context

The RSO’s requirement or situation the feature addresses and benefits gained. Some examples include:

oLong-term records management of the data items the feature relates to

oSpeed and convenience in finding specific or specific types of records

oRegulatory obligations, guidelines or standards the feature assists in meeting

oFinancial savings or cost benefits the feature provides

oTypical usage scenarios

How Historion addresses the requirement or situation for the Radiation Safety Officer

2.Operational instructions and reference

How to use the feature

Enumerated steps and check lists if applicable for most common tasks

How related data is affected and considerations when making changes

How Historion handles deleting the record type involved, its parent or child records

Best practices, data naming conventions or standards applicable

Problems that can arise and situations to avoid

3.Other design, process or administrative considerations and feature notes

Settings, options and adjustable reference lists that populate relevant dropdowns

Security or role-based controls or provisions applicable to the feature

Process, decision or information flow charts necessitated by complexity where helpful

Any limitations of the feature if relevant

Known situations to avoid, if applicable

IT Department or hosting provider considerations or decisions relative to the feature

Reasons for design decisions made not otherwise apparent without explanation or context

4.Future changes planned

Features identified for addition or improvement by Historion development team or customers

Additional functions intended already in prototype development, or at workshop stage

Additional functions intended for the feature in a future release, for which development partner and wider customer input and commentary are currently being solicited

5.Keyboard shortcuts: special navigation keys or control key options if applicable

6.External references that may expand on context, origin, industry significance or relevance

Copyright© Cybermynd Information Systems Consulting Pty Ltd