Tasks

Normally, a technical writer composes documents, as well as proofreading documents and UI.

But in most cases, document drafting comes first and foremost.

Some types of documentations that a TW writes are as follows:

1. User Guide
2. Installation Menu
3. Technical spreedsheet
4. API documents
5. Case Studies
6. White Paper
7. ...

User Guide

User Guide, also called user mannual, is a document that aims to help users get familiar with a company's document as soon as possible.

It can help make easy onboarding for new users, reduce customer support cost, improve customer satisfaction, reduce liability against wrong usage, and provide better sales collaterals.

It can adapt many forms, i.e, paper book, electronic book, user interface.

For instance, Apple has an iPhone User Guide to instruct user to be more successful with its iPhone products

Visit Apple Website to view iPhone User Guide

API Document

API documents are technical documents that provide information about how to effectively use and interact with an application programming interface (API). They serve as a crucial reference for developers and users who need to understand the functionality and capabilities of the API.

The functions of an API document primarily revolve around providing comprehensive and structured information about the API. These functions include:

1. Documentation: One of the main purposes of an API document is to document the API's functionality, methods, parameters, and expected inputs and outputs. This helps developers understand how to use the API and integrate it into their own software projects.
2. Instructional Guide: API documents serve as a guide for developers, providing step-by-step instructions on how to use and interact with the API. This includes details on authentication methods, error handling, and best practices for API integration.
3. Reference Material: API documents act as a reference material for developers, providing a quick and easy-to-navigate repository of the API's endpoints, functions, and available parameters. This allows developers to find the specific information they need to effectively utilize the API.

The features of an API document can vary depending on the specific API and its documentation style. However, some common features include:

1. Overview: An API document often starts with an overview that introduces the purpose and key features of the API.
2. Endpoints and Methods: The document provides a detailed list of API endpoints and the methods associated with them. It describes the functionality provided by each endpoint.
3. Parameters and Payloads: API documents outline the parameters that can be included in API requests and specify the expected format and data types. They also describe the structure of request payloads.
4. Authentication and Authorization: API documents explain the authentication methods required to access the API and any authorization requirements for specific actions or endpoints.
5. Examples: API documents typically include example API requests and responses to illustrate how to use the API effectively.
6. Error Handling: The document outlines possible error responses and explains how to handle them in API integration.

This website also provides API document for reference. For details, please see TW Vision API Document

Documents

Technical Writing Documents (Sample)

Name
IBM Style Guide
Grammar, punctuation, and capitalization a handbook for technical writers and editors (Mary K. McCaskill) (z-lib.org)
The Insiders Guide to Technical Writing 2nd Edition Krista Van Laan z-liborg
Microsoft Manual of Style for Technical Publications

Requirements

Degree

In China, a college degree or associate degree in computing science-related or english is enough;
In western world, such as USA, a college-degree or associate-degree holder or even a high-school diploma holder is qualified to become a technical writer candidate.

Writing skills

Darwin Information Typing Architecture (DITA) is an XML-based, end-to-end architecture for authoring, producing, and delivering technical information.
This architecture consists of a set of design principles for creating “information-typed” modules at a topic level and for using that content in delivery modes such as online help and product support portals on the Web.

For more information about DITA, please refer to Dita Best Practices A Roadmap for writing, editing and architecting in dita.

Foreign languages

English: TEM-4 or CET-6 or above

Tools

Category	Examples
Microsoft WORD	One of most widely used tools to writing technical documents
XML editing tools	notepad, notepad++, visual studio, 简书
Graphic processing tools	Adobe Illustrator, Photoshop
Flowchart tools	Visio, XMind
Translation tools	Trados, Memoq

Basic knowledge about programming languages

HTML,XML, JavaScript, and other popular ones if necessary

Industry knowledge

For instance, if the employer operates business in software industry, the TW candidate must know some basic knowledge about software, such as its general development process.

Resources

1. Online Courses

1.1 Technical Writing Courses

Every engineer is also a writer. This collection of courses and learning resources aims to improve your technical documentation. Learn how to plan and author technical documents. You can also learn about the role of technical writers at Google.

1.2 Techncial Writing Essentials

Learn the essentials of technical writing, technical reports, and professional communication with this online course. This free online technical writing course will teach you the basics of technical writing and communication. You will study the main conventions and characteristics of technical writing, the complexity and iterative nature of a writing process, and the importance of knowing your audience and writing specifically to meet their needs. You will also learn how to apply strategies to enhance clarity and readability, and more.

1.3 Technical Writing: A Quick Start to Software Documentation

In this quick start course, we start with a quick and direct overview of the end-to-end documentation creation processes. By the end of this course, you should get a basic understanding of what technical writing in software documentation is all about. You will be able to name the main assets (deliverables for your customers) that you create using technical writing skills and techniques. For example, such are the software documentation itself, images, as well as instructional videos, and multimedia.

1.4 learning Dita

LearningDITA is a site created by Scriptorium as a hub for DITA and content strategy training. It provides free e-learning for individuals who want to explore DITA, the Darwin Information Typing Architecture. This flexible training was designed so you can work through the course content on your own schedule. Lessons include exercises, links to additional resources and videos, and quizzes to test your knowledge.

2. Communities

Name	Description	URL
Write the Docs	Write the Docs is a global community of people who care about documentation. We have a Slack community, conferences on 3 continents, and local meetups	click here
TechWhirl	TechWhirl is an online resource for anyone interested in the world of Content Management and Technical Communication. Experienced veterans, up-and-coming professionals, students, and leaders in the management suite explore TechWhirl to find new, compelling, thought-provoking, and helpful information on creating and managing the information assets critical to their enterprise	click here
TC World	tcworld magazine is tekom's magazine for technical communication and international information management. Our articles and interviews focus on how companies live up to the challenges of communicating with customers, partners and employees in an increasing number of international markets. It is aimed at professionals who are involved in planning, creating, translating, localizing, publishing or distributing information in any language and format, and for any audience.	click here

3. Podcasts

4. Books

There are also "tons of" tw books which can make learning easier, such as following ones:

How to Become a Technical Writer

This book tells readers how to become a technical writer by elaborating on what is tw and what a tw does in his or her job, as well as how to prepare a resume.

Technical Writing for Dummies

As its name suggests, this book can help "dummies" who know nothing about technical writting start to get into the TW field.

Developing Quality Technical Information

This book teaches readers how to write technical information that is accurate, clear and user-friendly.

In bookshelf. a lot of books are comming......

Termbase

To faciliate learning on TW, a termbase is added to this website. You can click here to visit the termbase . Since the termbase just started off, I'd like to use any opinion or suggestions proposed by you. Please leave a comment about how you feel about this termbase or what is your advise for better user experience, in comment section. Thanks~