Wendie Ruano / 15 Feb 1999
Tech. Comm. II / X466 / T. Albert / Spring 1999
Documentation Plan
Documentation System Conversion Project: Paper to Web-Based
Purpose
The purpose of this book is to guide an individual in the successful planning and conversion of a paper-based documentation system to a web-based system.
Scope/Limitations
The scope of this book is limited to the major concepts involved in converting a paper-based documentation system to one that is web-based. Readers can go to the resources noted to get more in-depth information specific to particular issues. All attempts will be made to provide as thorough a document as possible within the purpose and scope described.
Audience Analysis
This book is intended for individuals responsible for the management of an organization’s documentation system and/or a conversion project of this type. It is expected the individuals are computer- and web-literate. It is assumed they are versed in the basic concepts involved. Concepts should introduce material that is at least somewhat new to the reader, or else that reader has no reason to read. It is also assumed they are seeking additional guidance necessary to identify and evaluate the requirements and options involved in the project.
Content Profile
Preface
· Book description
· Audience definition
· How to use this book
· Conventions used in this book
Concepts
· Documentation and its various roles in business
· Delivery systems: traditional and electronic methods and techniques
· The future direction of relevant technology
· Web markup languages and when each might be best used
Procedures
· Evaluating a organization’s legacy system, requirements, and resources
·
Evaluating best available technology against the defined parameters
· Managing a documentation conversion project
Job Aid
·
Basic Documentation Project Management
References
· Tutorial based on one of the procedures above
· Information on browsers
· Web and software resources
· Printed-book bibliography
· Glossary
Document Types
The major types of documentation styles that will be included in this book are: concepts, procedures, tutorial, job aid, front matter and back matter, including reference appendices.
Research Requirements
Research requirements necessary to the production of this book include the following items:
· Relevant plans for the organization’s future growth, direction, and/or development
· Information on the organization’s server/platform
· 24-hour access to the organization’s document center and copy center
· Access to work stations networked to company LAN
Preliminary Page and Screen Designs
The book will be formatted for 8 ½ x 11" paper. The book will use a distinctive page design for the beginning of each chapter. Paragraph styles will be used to give quick visual cues for chapter names, section headers, procedure names, body text, and numbered procedures. Headers will include chapter number, page number, and chapter title. The book will be designed for single-sided printing. For clarity and ease-of-use, screen shots and visual examples will appear interspersed throughout the text where relevant or in the reference section when not otherwise possible.
Schedule of Deliverables
Monday, Feb. 1: Research and define project topic. Start documentation plan.
Monday, Feb. 8: Submit documentation plan. Start audience definition and
concepts.
Monday, Feb. 15: Complete audience definition. Start procedures.
Monday, Feb. 22: Complete concepts. Start tutorial.
Monday, Mar. 1: Complete procedures. Start quick start/job aid.
Monday, Mar. 8: Complete tutorial and quick start/job aid. Start reference.
Monday, Mar. 22: Complete reference. Edit and revise components as needed.
Monday, Mar. 29: Prepare conventions, title page, table of contents, glossary,
and index.
Monday, Apr. 5: Complete final revisions and production.
Monday, Apr. 12: Release and present. Best to try to finish by April 5, the last day of class.