Scribd
Upload
3 views7 pages

Documentation Plans for Technical Writing

The document discusses two types of documentation plans used by professional technical writers: documentation specifications (doc specs) for individual documents and documentation project plans for sets of documents. Doc specs help organize thoughts, communicate intentions, and reach consensus among team members. Documentation project plans summarize how multiple documents fit together in a project.

Uploaded by

Mohamed allaeldin
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
3 views7 pages

Documentation Plans for Technical Writing

The document discusses two types of documentation plans used by professional technical writers: documentation specifications (doc specs) for individual documents and documentation project plans for sets of documents. Doc specs help organize thoughts, communicate intentions, and reach consensus among team members. Documentation project plans summarize how multiple documents fit together in a project.

Uploaded by

Mohamed allaeldin
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

ENGL 214

3rd Lecture
Documentation Plans

Chapter 3
Most professional technical writers produce
the following two types of documentation
plans:
– documentation specifications (doc specs), which detail a single document
– documentation project plans, which detail a set of documents

Why?
To provide a formal feedback mechanism for other people in an
enterprise.
Document Specifications (Doc Specs)
A good doc spec serves the following three purposes:

– • It helps you organize your thoughts about the document.


– • It communicates your intentions to the other members of the
engineering team.
– • It helps your team reach consensus on the purpose and scope of
the document before you start writing.
Document Specifications (Doc Specs)

Content & Sample


Pages (22- 24)
Documentation Project Plans
A documentation project plan summarizes an entire
documentation set, explaining how different pieces of the
puzzle fit together. If your team is writing multiple
documents, you should create a documentation project plan.
Document Specifications (Doc Specs)

Content & Sample


Pages (25- 27)

You might also like