Technical Writing

1. Considerations in Technical Writing

1.1. Research

1.1.1. one of the first steps in technical writing

1.1.2. collecting data and turning it to valuable information

1.1.3. Research can come from a variety of places

1.1.3.1. On-Site Data

1.1.3.2. Online and Intranet Publications

1.1.3.3. Interviews

1.1.3.4. Libraries and Research Databases

1.2. Audience Perception

1.3. Communication Skills

1.4. Technical Skills

1.5. Writing

1.6. Document Design

1.7. Fluency with Digital Tools

1.8. User Research and Testing

1.9. Industries That Use Technical Writing

2. Roles

2.1. to enable your readers to understand a highly complex process or concept clearly.

3. Definition

3.1. the practice of documenting processes.

3.1.1. software manuals

3.1.2. instructional materials.

3.2. encompasses all documentation of complex technical processes.

3.3. This writing style covers any type of text that aims to explain detailed information. A technical writer communicates in a way that presents technical information so that the reader can use that information for an intended purpose.

3.4. Technical information must be distilled and presented unambiguously. This can come in the form of technical reports, emails, policy, briefs, and press releases.

4. Process of technical writing

4.1. Project Preparation

4.1.1. this step may be initiated by

4.1.1.1. Employer

4.1.1.2. Colleague

4.1.1.3. Client

4.2. Audience Analysis

4.3. Understand the User

4.4. User Experience