OUM

DO.070 USER GUIDE

<Company Long Name>
<Subject>
Note: When this template is completed, delete all the
yellow notes as follows:

1. With your document open, open the Find and

Replace window.
2. Expand the Find and Replace window using the
More>> button.
3. Place the cursor in the Find what: field.
4. Choose Format > Style.
5. When the Find Style box opens, scroll through the
list and select Note and click OK.
6. Leave the Replace with: field blank.
7. Select Replace, Replace All or Find Next to
remove the yellow notes.
8. Repeat using the Note Wide style if there are any
landscape sections that contain wide yellow notes.
Note: Please refer to the OUM Template User’s Guide for
detailed instructions for working with OUM
templates.

Author: <Author>
Creation Date: May 6, 2014
Last Updated: May 14, 2022
Document Ref: <Document Reference Number>
Version: DRAFT 1A
DO.070 User Guide Doc Ref: <Document Reference Number>
September 18, 2016

Note: Title, Subject, Last Updated Date, Reference

Number, and Version are marked by a Word
Bookmark so that they can be easily reproduced in
the header and footer of documents. When you
change any of these values, be careful not to
accidentally delete the bookmark. You can make
bookmarks visible by selecting the Office
Button>Word Options>Advanced> and checking
the Show bookmarks option in the Show
document content region.

Approvals:

<Approver 1>

<Approver 2>

Note: To add additional approval lines, press [Tab] from

the last cell in the table above.

Note: You can delete any elements of this cover page that
you do not need for your document.

<Subject> Document Control ii

File Ref: DO-070_USER_GUIDE.DOC (v. DRAFT 1A )
DO.070 User Guide Doc Ref: <Document Reference Number>
September 18, 2016

1 Document Control

1.1 Change Record

3

Date Author Version Change Reference

14-May-05 <Author> Draft 1a No Previous Document

1.2 Reviewers

Name Position

<Subject> Document Control iii

File Ref: DO-070_USER_GUIDE.DOC (v. DRAFT 1A )
DO.070 User Guide Doc Ref: <Document Reference Number>
September 18, 2016

2 Preface
Note: Provide a brief introductory sentence for the
Preface.
Note: If you change the main headings for this Preface,
then be sure to update the bullet list below.
Note: To update the cross-references in the bullet list:

1. Choose Insert > Cross-Reference.

2. Select the correct heading, and click OK.

This document …
Topics discussed are:
•
•
•
•
•

2.1 How The Manual Is Organized

This manual is divided in <Number of Sections> sections:
• <Section 1>
• <Section 2>

<Section 1>

<Section 2>

2.1.1 Audience
Note: Identify the audience of the guide.
This manual is written for...

2.1.2 How to Use This Manual

Note: Describe how the manual should be used. For
example, should the user read it entirely before
beginning to use the system (conceptually written
information)? Or can the user find task topics to
refer to as needed (task-oriented information)?

<Subject> Preface 1 of 8
File Ref: DO-070_USER_GUIDE.DOC (v. DRAFT 1A )
DO.070 User Guide Doc Ref: <Document Reference Number>
September 18, 2016

2.1.3 Related Documents

Note: List related documentation, such as product user
manuals.

2.1.4 Your Comments are Welcome

<Company Short Name> values and appreciates your comments as a user and reader of this manual. As we write,
revise, and evaluate our documentation, your comments are the most valuable input we receive. If you would like to
contact us regarding comments and suggestions on future releases of <Subject>, please use the following address or
telephone numbers:
<Company Long Name>
<Contact Address>
<Contact Phone Number> Email: <Contact Email>

<Subject> Preface 2 of 8
File Ref: DO-070_USER_GUIDE.DOC (v. DRAFT 1A )
DO.070 User Guide Doc Ref: <Document Reference Number>
September 18, 2016

Contents

1 Document Control ..................................................................................................... iii

1.1 Change Record ........................................................................................................... iii
1.2 Reviewers .................................................................................................................... iii

2 Preface ......................................................................................................................... 1
2.1 How The Manual Is Organized ..................................................................................... 1

3 Chapter 1 - <Chapter Title> ....................................................................................... 4

3.1 Topical Essay ............................................................................................................... 4

4 Appendix A .................................................................................................................. 6

5 Glossary ...................................................................................................................... 7

6 Open and Closed Issues ............................................................................................ 8

6.1 Open Issues ................................................................................................................. 8
6.2 Closed Issues ............................................................................................................... 8

Note: To update the table of contents, put the cursor

anywhere in the table and press [F9]. To change
the number of levels displayed, select the menu
option Insert->Index and Tables, make sure the
Table of Contents tab is active, and change the
Number of Levels to a new value.

<Subject> Preface 3 of 8
File Ref: DO-070_USER_GUIDE.DOC (v. DRAFT 1A )
DO.070 User Guide Doc Ref: <Document Reference Number>
September 18, 2016

3 Chapter 1 - <Chapter Title>

This Chapter...

Note: Use this section to divide your document into

chapters.

The chapter number above is a Word Sequence

field that automatically updates to reflect the correct
chapter number when you have multiple chapters in
your document.

Also consider dividing your document into sections

by inserting a section break before each chapter.
You can also include the current chapter number in
captions and page numbers using by inserting a field
(Insert->Field…) with the contents:

Seq Chapter \c

For more information, search for “Sequence” in

Word for Windows help.

3.1 Topical Essay

The User Guide is a role-based document that provides specific user procedures to follow based on the user’s role.

3.1.1 Procedures
Scope
This procedure covers the following functional areas:
•
•
•
System References
The following system references are used:
•
•
•
Policy
The following policy guides the execution of this procedure:
•
•
•

<Subject> Chapter 1 - <Chapter Title> 4 of 8

File Ref: DO-070_USER_GUIDE.DOC (v. DRAFT 1A )
DO.070 User Guide Doc Ref: <Document Reference Number>
September 18, 2016

Responsibility
<Role 1> is responsible for:
•
•
•
<Role 2> is responsible for:
•
•
•
Distribution
The following persons receive distribution of this document:
• <Role 1>
• <Role 2>
Ownership
<Role 1> is responsible for ensuring this document is necessary, reflects actual practice, and supports corporate
policy.
Activity Preface
This activity is performed when …
This activity does not cover …

3.1.2 Navigation Instructions

• Distribution
• Related Procedures
• Ownership
• Alternative Regions

3.1.3 Business Forms

• Purpose
• Usage
• Attributes
• Filing
• Distribution
• Ownership

3.1.4 Reference Documents

• Distribution
• Ownership

<Subject> Chapter 1 - <Chapter Title> 5 of 8

File Ref: DO-070_USER_GUIDE.DOC (v. DRAFT 1A )
DO.070 User Guide Doc Ref: <Document Reference Number>
September 18, 2016

4 Appendix A

<Subject> Appendix A 6 of 8
File Ref: DO-070_USER_GUIDE.DOC (v. DRAFT 1A )
DO.070 User Guide Doc Ref: <Document Reference Number>
September 18, 2016

5 Glossary
Note: Use the following table or replace it with your own
project’s glossary format.
Note: Review the project Glossary (RD.042). You may
wish to replace this section in total or part with the
project Glossary (RD.042).

Term Type Definition or Synonym

<Subject> Glossary 7 of 8
File Ref: DO-070_USER_GUIDE.DOC (v. DRAFT 1A )
DO.070 User Guide Doc Ref: <Document Reference Number>
September 18, 2016

6 Open and Closed Issues

Note: Add open issues that you identify while writing or

reviewing this document to the open issues section.
As you resolve issues, move them to the closed
issues section and keep the issue ID the same.
Include an explanation of the resolution.

When this work product is complete, any open

issues should be transferred to the project- or
process-level Issue Log (Manage focus area) and
managed using a project level Issue Form (Manage
focus area). In addition, the open items should
remain in the open issues section of this work
product, but flagged in the resolution column as
being transferred.

6.1 Open Issues

ID Issue Resolution Responsibility Target Date Impact Date

6.2 Closed Issues

ID Issue Resolution Responsibility Target Date Impact Date

<Subject> Open and Closed Issues 8 of 8

File Ref: DO-070_USER_GUIDE.DOC (v. DRAFT 1A )