Technical Writer
- Technical Writer
- the role that is played when a person
produces technical documentation by incorporating content and corrections from other roles
As illustrated in the preceding figure, Technical Writer is part of the following inheritance hierarchy:
The typical role-specific responsibilities of a Technical Writer are to:
- Capture figures from whiteboard using modeling tool(s).
- Capture and edit the contents technical documentation from the technical staff.
- Produce technical, operational, and end-user documentation.
- Improve the readability of documentation.
- Capture inspection meeting results.
- Incorporate approved inspection comments into document.
- Place the documents under configuration control.
- Maintain the documents.
Technical writers typically inherit the
general role responsibilities from the
role process component.
To fulfill these responsibilities, technical writers
typically should have the following expertise, training, and
experience:
- Modeling tools.
- Endeavor conventions (e.g., content and format standards,
templates, inspection checklists).
- Excellent verbal and written communication skills.
- A bachelor’s degree or better in English literater,
journalism, software engineering, computer science, or the
equivalent.
Technical writers typically perform the following
role-specific tasks in an iterative,
incremental, parallel, and time-boxed manner:
Technical writers typically inherit
common role tasks from the
role method component.
Techical Writers typically perform these tasks as members of the following teams:
- Strategy Teams:
- Development Teams:
- Evaluation Teams:
As members of these teams, technical writers produce all or
part of the following work products:
- It is usually more cost-effective to use technical
writers than to have analysts, architects, designers,
implementors, and testers produce and maintain their own
documents.
- This role typically inherits the
common team guidelines from the
roles method component.
