Technical Writing Guidelines
Technical Writing Guidelines
September 1, 2004
Copyright
© 2004 by The Natchez Group Inc., dba TechProse. All rights reserved. The information disclosed herein is proprietary information owned by The Natchez Group Inc., dba TechProse
(“TechProse”). This information shall be used solely and exclusively by University of Berkeley
Extension students as part of their course and reference material for Technical Communication 1.
The information herein shall be used by or disclosed to others only for this purpose.
Published: January 2, 2003
Updated: September 1, 2004
Trademarks
All trademarks in this document are held by their respective owners.
Revision History
Date
Rev
Description
Author
12/16/2002
1/2/2003
9/1/2004
001
1.00
2.00
Initial Draft
Final Draft
Manual Review and Update
Meryl Natchez, Ann Tosello
Meryl Natchez, Linda Fogel
Meryl Natchez
Preface
Preface
TechProse is a technical writing, training, and information technology consulting company in business since 1982. This manual provides technical writing guidance and sets standards for creating logical and professional written material. This manual is proprietary. TechProse provides it to staff writers, consultants, and students studying
Technical Writing with a TechProse staff member.
This manual describes the process of writing good documentation. It is designed to be read from beginning to end, as well as to be used as a guide to refer back to once the material is familiar. TechProse staff follow this guidance in preparing all documents.
Some of the material in this guide is based on problems that seem to arise for multiple projects. For example, many writers find the difficulty in writing a report is knowing where to start. The information in the “Getting Started” chapter is designed to help you determine the purpose, use, and audience of your document to facilitate getting started.
Managers expressed concern that reports often are not
September 1, 2004
Copyright
© 2004 by The Natchez Group Inc., dba TechProse. All rights reserved. The information disclosed herein is proprietary information owned by The Natchez Group Inc., dba TechProse
(“TechProse”). This information shall be used solely and exclusively by University of Berkeley
Extension students as part of their course and reference material for Technical Communication 1.
The information herein shall be used by or disclosed to others only for this purpose.
Published: January 2, 2003
Updated: September 1, 2004
Trademarks
All trademarks in this document are held by their respective owners.
Revision History
Date
Rev
Description
Author
12/16/2002
1/2/2003
9/1/2004
001
1.00
2.00
Initial Draft
Final Draft
Manual Review and Update
Meryl Natchez, Ann Tosello
Meryl Natchez, Linda Fogel
Meryl Natchez
Preface
Preface
TechProse is a technical writing, training, and information technology consulting company in business since 1982. This manual provides technical writing guidance and sets standards for creating logical and professional written material. This manual is proprietary. TechProse provides it to staff writers, consultants, and students studying
Technical Writing with a TechProse staff member.
This manual describes the process of writing good documentation. It is designed to be read from beginning to end, as well as to be used as a guide to refer back to once the material is familiar. TechProse staff follow this guidance in preparing all documents.
Some of the material in this guide is based on problems that seem to arise for multiple projects. For example, many writers find the difficulty in writing a report is knowing where to start. The information in the “Getting Started” chapter is designed to help you determine the purpose, use, and audience of your document to facilitate getting started.
Managers expressed concern that reports often are not
References: Introduction to Technical Writing Rev 2.00, September 1, 2004 Rev 2.00, September 1, 2004 Introduction to Technical Writing Introduction to Technical Writing Rev 2.00, September 1, 2004