|
|
|
Procedures for Documentation
and Online Help
Systems
Research
& Analysis - Effective documentation begins with
research and a clear understanding of
the content and its purpose. Herndon Enterprise will
work with you to:
- Identify the target
audience(s)
- Clearly define the
intended purpose and scope of the content and material
- Identify
the highlights of what the audience(s) should be able to do using the
help system
- Identify any special
considerations for online help - WebHelp, HTML Help or
WinHelp
Design
and Model Pages
- Based on the identified audience and purpose, Herndon
Enterprise will work with you to develop the following for
your review:
- A
preliminary topic list
or table of contents
- Prototype or model pages (Web
and/or paper) to serve as a guide for the remainder of the
development
- Samples of online pages or
skeleton pages that shows the basic structure, navigation and
layout of the pages
First Draft Review - Based on the preliminary topic list and model
pages, Herndon Enterprise will develop the First Draft for
your review. The draft will include:
- Formatted pages with presented content for each
topic -- content may come from your existing source
documentation and/or observations and interviews with your
end users or
subject matter experts (SMEs).
- All questions and comments are embedded directly in the draft
identifying content gaps, inconsistencies, or confusions,
and suggestions about any other information you might
want to include.
Second Draft Review - Based on your review and edit of the First Draft,
Herndon Enterprise will develop the Second Draft, which will
include:
- All
responses to our questions/comments will be incorporated into
the second draft
- Incorporation of any
other edits you make to the First Draft.
- A complete set of online help files with working
navigation, graphics, and other elements
End
User Testing - Herndon Enterprise will work with you to test the
help system with end users to be sure that:
- The help system contains the information users need and
expect
- Your information is clear, concise
and accurate
- Your help system is easily
accessible and easy to
understand
- Your online help is easy to navigate, easy to search,
and user-friendly
Final Version - Herndon Enterprise will incorporate any final
edits suggested by the Usability Test and deliver a Final to
you including all electronic source files.
|
|
|
Procedures for User Guides and
Technical Manuals
Research and Analysis - Herndon
Enterprise will research the application or system and work with you
to:
- Analyze the system or application to
understand its functionality and use
- Identify the target
audience(s)
- Clearly define the
intended purpose and scope of the project
Design and Formatted Pages -
Based on the identified audience and use, Herndon Enterprise
will work with you to develop the following for your review:
- A table
of contents outlines the formatted pages/sections/chapters
- Prototype or model pages to serve as
a guide for the remainder of the project
- Samples of skeleton pages that shows
the basic structure, format and layout of the pages
Draft Reviews and Feedback - We
understand the importance of reviews and feedback to ensure
satisfaction, Herndon Enterprise will work with you at all phases of
development to:
- Carefully analyzed and presented
material for each section -- material may come from your existing source
documentation and/or observations and interviews with your
end users or
subject matter experts (SMEs).
- All questions and comments are embedded directly in the draft
identifying any gaps, inconsistencies, or confusions
- Noted suggestions about any other information you might
want to include
- Allowance for review and feedback
(face-to-face discussions with documents are recommended)
Final Version - Herndon Enterprise will incorporate any final
edits suggested in the review sessions and deliver a Final to
you including all source files and images.
|
