Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

Admin 3 4 document style guide for standards v3 120827

ABN ADMIN Document Style Guide for Standards ? Version K B Taylor CEO RISSB August ADMIN Document Style Guide for Standards Version August CDOCUMENT CONTROL Identi ?cation Document Title Document Style Guide for Standards Document Style Guide for Standards Document Style Guide for Standards Number ADMIN ADMIN ADMIN Document Style Guide for Standards Version Date Document History Publication Version E ?ective Date Page s A ?ected All All All Reason Document Creation Review and update Review and update ADMIN Document Style Guide for Standards Version August CDocument Style Guide - Standards Table of Contents Identi ?cation 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 Identi ?cation 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 De ?nitions Section Requirements Terminology Uncertainties ADMIN Document Style Guide Standards V August Page of CDocument Style Guide - Standards Ambiguous requirements Realistic requirements Veri ?able requirements Repetition Performance and prescriptive requirements Source quality Document Factors Document Control Identi ?cation Preparation Approval Distribution and Change Document History MS Excel Document Format Section and Clause Numbering Location and Alignment Font Colour Requirements Classi ?cation Use of Type Column Interface Coordination Background Information Single simple requirements Record Requirements ADMIN Document Style Guide Standards V August Page of CDocument Style Guide - Standards 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 de ?ned 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 PM receives Request for Development What type of document is to be produced Requirements based Rules Codes of Practice or Guidelines MS Excel Template MS Word Template 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 this is all that the author requires Documentation read as if produced by a single writer While the style and look of the document have some bearing on this it is most important that the writing itself be consistent ADMIN Document Style Guide Standards V August Page of CDocument Style Guide - Standards Scope This style guide has been produced as a RISSB procedure to