Creating a doc spec

Abstract

All technical documentation projects benefit from a good content plan or doc spec. The doc spec is a blueprint for a document. It identifies the product, users, source materials, and subject matter experts (SME). It also provides a preliminary outline of topics, and it estimates the effort to produce the document. Although the doc spec described is for a printed software user guide, you can adapt your doc spec for other types of documentation, including hardware manuals and training guides. The doc spec template is simply a tool that leads you through the document planning and estimating process. Your customized doc spec captures the who, what, when, why, and how of your project.

Journal
IEEE Transactions on Professional Communication
Published
1999-06-01
DOI
10.1109/47.768166
CompPile
Search in CompPile ↗
Open Access
Closed
Topics
Export

Citation Context

Cited by in this index (0)

No articles in this index cite this work.

Cites in this index (0)

No references match articles in this index.