Admin 3 4 document style guide for standards v3 120827
ADMIN Document Style Guide for Standards Version August ABN ADMIN Document Style Guide for Standards ? Version K B Taylor CEO RISSB August Document Style Guide for Standards ADMIN Document Style Guide for Standards Version August DOCUMENT CONTROL Identification Document Title NumberVersionDate Document Style Guide for Standards ADMIN Document Style Guide for Standards ADMIN Document Style Guide for Standards ADMIN Document History Publication Version Effective DatePage s AffectedReason All Document Creation All Review and update All Review and update Document Style Guide - Standards ADMIN Document Style Guide Standards V August Page of Table ?of ?Contents ? Identification ? Document History ? Document Style Guide for Standards ? ?Purpose ? ?References ? ?Process ? ?Scope ? ?Using this Style Guide ? ?Writing Expression ? ?Paragraph and Sentence Length ? ?Less is More ? ?Page Size ? ?Embedding an Image ? ?Document Style and Structure ? ?Headers and Footers ? ?Appendices ? ?Element Structure ? ?Identification ? ? Standards ? ?Section and Clause Numbering ? ?Tables Figures and Equations ? ?CONTENT ? ?Language and Units ? ? Introductory Section ? ?Disclaimer Section ? ?Document Control Section ? ?Content Section ? ?Purpose Section ? ?Scope Section ? ?Compliance Section ? ?Referenced Documents Section ? ?Definitions Section ? ? Requirements ? ?Terminology ? ?Uncertainties ? Document Style Guide - Standards ADMIN Document Style Guide Standards V August Page of ?Ambiguous requirements ? ?Realistic requirements ? ?Verifiable requirements ? ?Repetition ? ?Performance and prescriptive requirements ? ?Source quality ? ?Document Factors ? ?Document Control ? ?Identification ? ?Preparation Approval ? ?Distribution and Change ? ?Document History ? ?MS Excel Document Format ? ?Section and Clause Numbering ? ?Location and Alignment ? ?Font ? ?Colour ? ?Requirements Classification ? ?Use of Type Column ? ?Interface Coordination ? ?Background Information ? ?Single simple requirements ? ? Record Requirements ? Document Style Guide - Standards ADMIN Document Style Guide Standards V August Page of Document Style Guide for Standards Purpose The purpose of this document is to provide RISSB users with a style guide that regulates the creation and development of RISSB Standards documents References All Terms abbreviations and acronyms used in this document are defined in the RISSB Quality Management Glossary Process This guide should be used in conjunction with the Master Template from which all future standards document development is based This procedure is based on MS Excel style documents MS Excel is predominantly used for technical standards that are used to document requirements whereas MS Word is used for non-technical standards e g Rules Codes of Practice and Guidelines The Project Manager will direct the style of document to be developed as per Figure MS Excel Template MS Word Template Rules Codes of Practice or Gu id el ines Re qu irem ents based W hat type of document is to be produced PM receives Request for Development Figure Project Decision Document templates are available from the Project Manager The template provided is designed to comply with this procedure and therefore in most cases