Development of Procedures and Technical Manuals for the Marine and Offshore Industries/Разработка процедур и технических руководств для морской промышленности

Издание на английском языке
The book is dedicated to the development and implementation of effective educational materials related to safety and environmental protection in the marine industry. She emphasizes the importance of consistency in documentation to ensure the quality and safety of operations, including administrative, regulatory, and technical guidelines. The main purpose of the book is to help organizations adapt their materials to modern practices and requirements, as well as integrate updated documents into safety programs in order to increase productivity and reduce accidents. Although the recommendations are not mandatory, they are intended to help technical authors create documents that meet the needs of their organizations.

Contents
1 Introduction
1.1 General
1.1.1 Application
1.1.2 Definitions for Instructional Materials
1.2 Definitions of a Procedure
1.2.1 Compliance with Standards
1.3 Definitions of a Technical Manual
1.4 Importance of Instructional Materials
1.5 Influencing Compliance and Performance
1.6 Structure of this Guidance
2 The Role of Instructional Materials
2.1 General
2.1.1 Definitions
2.1.2 Limits of Written Materials Relating to Maritime Environments
2.2 Purpose of Instructional Materials
2.3 Uses of Instructional Materials
2.4 Concerns to Address in Instructional Materials
2.4.1 High-Level Concerns
2.4.2 Safe Operating Limits
2.5 Types of Instructional Materials
2.6 Management Oversight of Instructional Materials
3 Writing Instructional Materials
3.1 General
3.1.1 Definitions
3.2 Initiations of New Instructional Materials
3.3 Goal Definition
3.4 Management Approval to Proceed
3.5 Information Gathering
3.5.1 Subject Matter Experts (SME)
3.5.2 Source/Supporting Documentation
3.5.3 Writing to a Specific Audience
3.6 Effective Presentation of Material
3.7 Enhancing Usability
3.7.1 User Participation
3.7.2 Instructional Material Effectiveness
3.7.3 Instructional Material Maintenance
3.8 Instructional Material Writing Elements
3.8.1 Instruction Number
3.8.2 Clarity
3.8.3 Brevity
3.8.4 Use of Imperative (Command) Sentence Structure
3.8.5 User Friendliness/Usability
3.8.6 Technical Accuracy
3.9 Style Format Guidelines
3.9.1 Font
3.9.2 Sentence Structure
3.9.3 Vocabulary
3.9.4 Level of Detail
3.10 Document Organisation
3.10.1 Front Matter
3.10.2 Document Sections
3.10.3 Ending the Procedure
3.10.4 Appended Information
4 Graphics in Instructional Materials
4.1 General
4.1.1 Definitions
4.1.2 Graphics
4.1.3 Sources of Graphics
4.1.4 Types of Graphics
4.1.5 Guidelines for Using Graphics in Instructional Materials
4.1.6 Incorporating Electronic Media into Instructional Materials
5 Verifying, Validating, Approving, Certifying, and Implementing Instructional Materials
5.1 General
5.1.1 Definitions
5.1.2 Final Phase of Instructional Document Development Process
5.2 Verifying and Validating Instructional Materials
5.2.1 Verification
5.2.2 Validation
5.3 Resolving and Incorporating Final Comments
5.4 Proofreading and Checking for Format and Style
5.4.1 Proofreading
5.4.2 Instructional Document Format and Style
5.5 Approving the New/Revised Instructional Materials
5.6 Certifying the New Instructional Materials
5.7 Implementing New/Revised Instructional Materials
5.7.1 Planning for Implementation
5.7.2 Distribution
6 Managing Instructional Materials
6.1 General
6.1.1 Document Control
6.1.2 Access
6.1.3 Training
6.2 Maintenances of Instructional Materials
6.2.1 Updates
6.2.2 Periodic Reviews
Appendix A: Checklist for the Preparation of Instructional Materials
Appendix B: Example Constrained Word List and Constrained Language List
Appendix C: Analysis Technique
Appendix D: Examples of Instructional Materials
Bibliography