EPLC_User_Manual_v . .doc

User Manual

Food and Drug Administration

<Project Name & Release Version #> Enterprise Performance LifeCycle uSER MANUAL Document Version Number: <1.0> Document Version Date: <mm/dd/yyyy> Notes to the Author

[This document is a template of a User Manual document for a project. The template includes instructions to the author, boilerplate text, and fields that should be replaced with the values specific to the project.

· Blue italicized text enclosed in square brackets ([text]) provides instructions to the document author, or describes the intent, assumptions and context for content included in this document.

· Blue italicized text enclosed in angle brackets (<text>) indicates a field that should be replaced with information specific to a particular project.

· Text and tables in black are provided as boilerplate examples of wording and formats that may be used or modified as appropriate to a specific project. These are offered only as suggestions to assist in developing project documents; they are not mandatory formats.

When using this template, the following steps are recommended:

1. Replace all text enclosed in angle brackets (e.g., <Project Name>) with the correct field document values. These angle brackets appear in both the body of the document and in headers and footers. To customize fields in Microsoft Word (which display a gray background when selected) select File->Properties->Summary and fill in the appropriate fields within the Summary and Custom tabs.

After clicking OK to close the dialog box, update all fields throughout the document selecting Edit>Select All (or Ctrl-A) and pressing F9. Or you can update each field individually by clicking on it and pressing F9.

These actions must be done separately for any fields contained with the document’s Header and Footer.

2. Modify boilerplate text as appropriate for the specific project.

3. To add any new sections to the document, ensure that the appropriate header and body text styles are maintained. Styles used for the Section Headings are Heading 1, Heading 2 and Heading 3. Style used for boilerplate text is Body Text.

4. To update the Table of Contents, right-click on it and select “Update field” and choose the option - “Update entire table”.

5. Before submission of the first draft of this document, delete this instruction section “Notes to the Author” and all instructions to the author throughout the entire document.

VERSION HISTORY

[Provide information on how the development and distribution of the User Manual will be controlled and tracked. Use the table below to provide the version number, the author implementing the version, the date of the version, the name of the person approving the version, the date that particular version was approved, and a brief description of the reason for creating the revised version.] Version Number Implemented

By Revision

Date Approved

By Approval

Date Description of Change

Table of Contents

51.0

PURPOSE AND SCOPE

52.0

CONSIDERATIONS

63.0

USER DOCUMENTATION CHECKLIST

74.0

DOCUMENT FORMATS

75.0

DOCUMENT ORGANIZATION

75.1

MANUALS…………………………………………………………………………………

75.2

ON-LINE HELP TOPICS…………………………………………………………………

8APPENDIX A: USER MANUAL APPROVAL

9APPENDIX B: REFERENCES

10APPENDIX C: KEY TERMS

1.0 PURPOSE AND SCOPE

[The purpose of this guide is to assist the Project Manager and technical writing staff with the identification and organization of the various types of user documentation that will be produced as part of this project. While this guide may be used by projects of any size, it is mainly intended for the larger, more complex, and more critical projects.

Although the identified documents will not be authored until the Development Phase of the Enterprise Performance Life Cycle (EPLC), the items in this guide should be considered during the Planning Phase, to ensure the planning, writing, and reviewing activities are factored into the project schedule.]

2.0 CONSIDERATIONS

[The project manager and/or technical writing staff should consider the following when determining what user documents to produce and the required content:

· How will the application be used?

· Who will be using the application?

· Primary/Power Users

· Basic Users

· What are the intended audiences for each document?

· What is the expected knowledge or experience level of each audience?

· How will the documents be organized?

· Who or what groups need to be involved with writing and reviewing the documents?

· Technical Writers

· Development Staff

· Users

· What will be the final formats of the documents?

· Printed Copies

· On-line copies

· On-line help topics

The following sections can be used to document the decisions related to the above listed items. ]

3.0 USER DOCUMENTATION CHECKLIST

The table below provides a general list of types of documents that could be produced. Modify the list as needed to reflect the items that will be produced by this project or release.

Trainers

Types of Training:

4.0 DOCUMENT FORMATS

[This section of the guide provides an area to identify the formats the final documents will be in:

· Electronic Format (web pages, on-line help topics, PDF files, etc.)

· Printed copies]

5.0 DOCUMENT ORGANIZATION

[Outline or define how the content of the various documents will be organized; this could be by function, action, or activity.]

5.1 MANUALS

[A table of contents skeleton could be generated for the manuals to ensure that each document has a consistent order and format.]

5.2 ON-LINE HELP TOPICS

[If applicable, determine how the topics will be accessed from within the application. They may be by hyperlinked key words or fields or a specific help menu. Also determine how the contents be will arranged, whether in alphabetical order, by topic, function, activity, or a combination of all items listed. ]

APPENDIX A: USER MANUAL APPROVAL

The undersigned acknowledge that they have reviewed the <Project Name> User Manual and agree with the information presented within this document. Changes to this User Manual will be coordinated with, and approved by, the undersigned, or their designated representatives.

Signature:

Date:

Print Name:

Title:

APPENDIX B: REFERENCES

[Insert the name, version number, description, and physical location of any documents referenced in this document. Add rows to the table as necessary.]

The following table summarizes the documents referenced in this document.

APPENDIX C: KEY TERMS

The following table provides definitions and explanations for terms and acronyms relevant to the content presented within this document.

Template Version 2.0 (Last Modified on Mar 27, 2009)

PAGE