book

Technical Documentation and Process

Name: Technical Documentation and Process
ISBN: 9781439861608

by Jerry C. Whitaker, Robert K. Mancini

September 2018

Intermediate to advanced

195 pages

4h 54m

English

CRC Press

Read now

Unlock full access

Cover
Half Title
Title Page
Copyright Page
Table of Contents
Preface
Acknowledgment
About the Authors
1. Overview
1.1 Introduction1.2 Plan for Success1.3 Elements of Process1.3.1 Documentation1.3.2 Social Media1.4 Putting It All Together
2. Equipment Documentation Strategies
2.1 Introduction2.2 Documentation Tools2.2.1 Types of Documentation2.2.1.1 Self-Documentation2.2.1.2 Database Documentation2.2.1.3 Graphics Documentation2.2.2 Labeling2.2.3 Other Documentation Tasks2.2.3.1 Operator/User Documentation2.2.3.2 Schematic Documentation2.2.4 Symbols2.2.5 Cross-Referencing Documentation2.3 SpecificationsBibliography

3. Developing a Style Guide
3.1 Introduction3.1.1 Definition of Documents3.2 General Structure of Documents3.2.1 Page Layout3.2.2 Standard Writing Practices3.2.2.1 Conciseness and Precision3.2.2.2 Consistency in Sentence Structure3.2.2.3 Punctuation3.2.2.4 Character Styles3.2.2.5 Headings and Titles3.2.2.6 Bulleted and Numbered Lists3.2.3 Image File Formats3.3 Document Creation and Editing3.3.1 Permissions3.3.2 Citing References3.3.2.1 Examples3.3.3 Terms3.3.4 Copyright, Trademark, and Legal Notices3.3.5 Document Numbering3.3.6 Maintaining Corporate Image Consistency3.4 Corporate Identity3.4.1 Logos3.4.2 Colors3.4.3 Software Interfaces3.4.4 Advertising Materials3.5 Reference BooksReferences
4. Meetings
4.1 Introduction4.2 Organization4.2.1 Responsibility of the Chairperson4.2.1.1 Minutes of the Meeting4.2.1.2 Scheduling Meetings4.2.1.3 The Agenda4.2.1.4 Quorum4.2.2 Challenges of Working Remotely4.2.2.1 Time Zones, Daylight Savings, Holidays4.2.2.2 Language Barriers4.2.2.3 Cultural Differences4.2.2.4 Voice Communications4.2.2.5 E-mail Communications4.2.2.6 Virtual or Remote Meetings4.2.2.7 File Sharing/Collaborating4.2.2.8 Less Formal Collaboration4.2.3 Developing a Scope of Work4.2.4 Developing a Work Plan4.3 Decision Making4.4 It’s All about LeadershipReferences
5. Systems Engineering
5.1 Introduction5.2 Systems Theory5.2.1 Systems Engineering Process5.2.2 Functional Analysis5.2.2.1 Synthesis5.2.2.2 Modeling5.2.2.3 Dynamics5.2.2.4 Optimization5.2.3 Evaluation and Decision5.2.3.1 Trade Studies5.2.4 Description of System Elements5.3 Phases of a Typical System Design Project5.3.1 Electronic System Design5.3.2 Detailed Design5.3.3 Budget Requirements Analysis5.3.4 Feasibility Study and Technology Assessment5.3.4.1 Planning and Control of Scheduling and Resources5.3.4.2 Project Tracking and Control5.4 Program Management5.4.1 Executive Manager5.4.2 Project Manager5.4.3 Systems Engineer5.4.4 Other Project Team MembersBibliography
6. Concurrent Engineering
6.1 Introduction6.2 Overview6.2.1 The Team Process6.3 The Process View of Production6.3.1 Quality Function Deployment (QFD)6.3.2 Design of Experiments (DOE)6.3.3 Robust DesignReferencesBibliography
7. Disaster Planning and Recovery
7.1 Introduction7.1.1 Developing a Disaster Plan7.2 Emergency Management7.2.1 The Planning Process7.2.2 Managing Risk7.2.3 Risk Assessment and Business Resumption Planning7.2.4 Workplace Safety7.2.5 Outside Plant Communications Links7.2.5.1 Outside Plant Wire7.2.5.2 Microwave Links7.2.5.3 Fiber Optic Links7.2.5.4 Satellite7.2.6 Emergency Power and Batteries7.2.7 Air Handling Systems7.2.8 Water Hazards7.2.9 Alternate Sites7.2.10 Security7.2.11 Staff Expectations, 9-1-1, and Emergencies7.3 Managing FearReferencesBibliography
8. Standards and Reference Data
8.1 Introduction8.1.1 The Standards Development Organization8.1.2 Professional Society Engineering Committees8.1.3 The History of Modern Standards8.2 Principal Standards Organizations8.2.1 International Organization for Standardization (ISO)8.2.2 International Electrotechnical Commission (IEC)8.2.3 International Telecommunication Union (ITU)8.2.4 American National Standards Institute (ANSI)8.3 Tabular DataReferencesBibliography
9. Document Templates
9.1 Introduction9.2 Final Thoughts
Index

Content preview from Technical Documentation and Process

9 Document Templates

9.1 Introduction

While the documentation requirements of a given company or organization may be unique, a starting point is useful. As such, the following document templates are provided to help readers develop their own templates. It is often useful for a company to draft and standardize on a set of templates, available to all document developers as a way of both speeding the process of preparing documentation and ensuring a consistent look and feel to the documents produced by the organization.

The following templates are provided in this chapter:

•Style guide

•Technical document

•Document log

•Meeting sign-in sheet

•Draft agenda

•Meeting minutes

•Work plan

•Change request

The templates presented here ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.

Julian F.

Head of Cybersecurity

I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.

Addison B.

Field Engineer

I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.

Amir M.

Data Platform Tech Lead

I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.

Mark W.

Embedded Software Engineer

Publisher Resources

ISBN: 9781439861608

Cloud Computing

Data Engineering

Data Science

AI & ML

Programming Languages

Software Architecture

IT/Ops

Security

Design

Business

Soft Skills

Technical Documentation and Process

by Jerry C. Whitaker, Robert K. Mancini

9

Document Templates

9.1 Introduction

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.