competency in skills and knowledge through assessment tests,
but are not required to complete a specific number of hours.
Technical Writer
USDOL
Work Process Content
On the Job Training
Confers with internal and external partners on new and existing projects
4
- Confers with stakeholders (such as product managers, customer representatives, vendors, plant executives, and publishers) to establish technical specifications and to determine subject material to be developed for publication
- Confers with clients and vendors to determine deliverable scope, format, and client publishing requirements as needed
- Coordinates development of documentation and digital content with internal and external stakeholders as needed
- Follows developments in specific fields and technological advancements of writing to determine need for revisions in previously published materials and development of new materials
Gathers information needed from a variety of sources
6
- Interviews clients such as program managers, subject matter experts, and production and engineering personnel, and reads industry journals and other material to become familiar with product technologies and production methods
- Determines operating procedures and details by observing activities, including production, developmental, and experimental activities
- Reviews background content information, statistical data, programmatic outputs, manufacturers and trade catalogs, drawings, wire frames and/or other data relative to operation, maintenance, and service of equipment
- Develops user profile of intended audience/consumer
- Compiles and organizes technical information or documentation from multiple sources using industry standards
- Identifies and collaborates with technical subject matter experts to gather resources
Participates in the writing process
8
- Writes and organizes informational materials that meets applicable quality standards related to order, clarity, conciseness, style, and terminology
- Produces work plans, project plan schedules, implementation guides, end-use guides, and provides field, data definition, and data flow documentation in addition to other relevant materials
- Includes all necessary high-quality technical documentation, such as specifications, requirements, designs, user guides, installation guides, and release notes
- Expresses programmatic and/or technical information in written format that is comprehensible to the primary audience of readers, whether technical, nontechnical, or both
- Expresses material in a clear, concise, and accessible manner using plain text, tailored to the intended audience
- Uses verbiage that is easily translated into other languages
- Establishes schedules for testing, drafting, and review
- Develops or maintains documentation in the intended publication format, including print or digital, such as web content for online published print materials
Reviews and revises written work as needed
9
- Edits, standardizes, or amends material prepared by subject matter experts, colleagues, or client organizations
- Reviews published materials and recommends revisions or changes in scope, format, content, and methods of reproduction and binding
- Ensures information, including technical information, is accurate, complete, and consistent with standards for quality, graphics, coverage, format, and style
- Creates, edits, modifies, and maintains version control of forms/documents to ensure timely updates
- Coordinates and facilitates the review and editing of documents when using a collaborative writing and review process
- Reviews all written communication to ensure proper formatting and style usage
- Reviews all written communication to ensure proper usage of grammar, spelling, punctuation, and adherence to relevant style guides
- Maintains records and files of work and revisions
- Uses technology, project management software, and Al tools to review and revise written work
Creates and compiles technical drawings and visuals for publication
4
- Studies drawings, specifications, mockups, and production samples to ensure clarity, accessibility, and concision for the intended audience
- Reviews details of technical drawings or specifications and ensures that they are accurate, accessible, easy to understand, and match the style and nomenclature of the document
- Selects photographs, drawings, sketches, diagrams, and charts to illustrate material, ensure simplicity, and understanding for the audience
- Draws sketches or captures screenshots to illustrate specified materials and assembly sequences
Participates in the technical content production process
8
- Arranges for typing, duplication, compilation, and distribution of materials as needed
- Assists in compiling and laying out material for publication including any content architecture creation (i.e., GitHub, MadCap Flare, and RoboHelp)
- Coordinates with teams across departments to prepare and troubleshoot materials for production and submission/publication
- Collaborates with marketing and communications colleagues to determine a publication dissemination strategy as needed
- Supports project managers and business analysts in tracking documentation deliverables, milestones, and deadlines, and ensures timely completion of all documentation tasks
- Coordinates logistics and personnel for final documentation and/or product release
- Gathers user feedback via first-hand experience and technical tools to improve user engagement
- Develops user profiles and user experience journey
Demonstrates professionalism and customer service acumen
9
- Demonstrates professional communication etiquette when interacting with colleagues, including responding in a timely manner
- Effectively manages time on assigned tasks, monitoring and tracking deadlines
- Demonstrates familiarity with organizational policies and processes including confidentiality
- Shows a willingness to learn and adapt to changes in work, priorities, deadlines, and team environment
- Complies with and demonstrates understanding of company policies about inclusivity and equity
- Incorporates Web Content Accessibility Guidelines (WCAG) and Section 508 compliance and accessibility into final public-facing deliverables
- Identifies challenges and develops solutions for addressing them independently, and with assistance from supervisors, as needed
- Works fairly, honestly, and with integrity
- Leverages principles of effective communication to collaborate and come to mutually beneficial solutions
Related Instruction Content
Training Provider(s):
Introduction to Technical Writing
30
Sample learning objectives * Explain the ethical responsibilities of a technical writer. * Describe the process that technical writers use to identify their target audience. * List and describe the types of reliable resources that are available for conducting research. * Explain the challenges of relying on web-based content for accuracy and reliability. * Describe the techniques used to assess written materials for bias. * Explain the importance of identifying one’s audience and the techniques used for producing documents that speak to that audience. * Discuss the purpose and general format of memos, white papers, research papers, instruction guides, employee manuals, user manuals, and grants. * Discuss the key elements of working in a UX environment. * Explain the unique challenges and opportunities available to technical writers who work in engineering, technology, software development, and medical fields. * Identify and correct errors in grammar and structure in written materials. * Explain the basic steps involved in technical writing, including planning, organizing, writing, editing, and revising technical writing. * Discuss the writing guidelines for social networking sites, blogs, wikis, and other electronic media.
Basic Grammar and Usage
40
Sample learning objectives * Demonstrate proper use of periods, commas, parentheses, colons, dashes, hyphens, and semicolons. * Demonstrate the ability to identify and properly use the following parts of speech: nouns, verbs, adverbs, adjectives, prepositions, conjunctions, and interjections. * Use subjects and verbs that agree. * Explain basic rules of capitalization and demonstrate the ability to follow those rules in written materials. * Explain the proper use of pronouns including possessive pronouns. * Identify and correct ambiguous pronouns by clearly linking the pronoun to the correct antecedent. * Explain the difference between a numbered and a bulleted list. * Demonstrate the ability to select appropriate homonyms, homophones, and homographs from a list of commonly confused or misused words. * Demonstrate proper use of tense in writing. * Properly spell and punctuate singular and plural collective nouns. * Identify and revise idioms.
Sentence Structure
45
Sample learning objectives * Explain the key components of well written sentences. * Identify key elements of sentences, including dependent and independent clauses, subjects, verbs, objects, and prepositional phrases. * List strategies for creating well written and properly punctuated compound and complex sentences. * Explain and demonstrate the ability to use various strategies to shorten sentences. * Differentiate between dependent and independent clauses. * Identify and correct instances of run-on sentences, subject-verb disagreement, and unnecessary repetition. * Describe the basic structure of a well-written paragraph. * Create clear, concise, and appropriately structured paragraphs. * Distinguish between active and passive voice and between first, second, and third person writing.
Project Planning for Technical Writers
20
Sample learning objectives * Describe the importance of a well-designed project plan for creating a technical document. * Identify the likely members of a technical writing project team and the role that each member will play in developing, editing, finalizing, and producing a technical document. * Explain the importance of copyright laws in developing print and electronic documents. * Describe the writing process and the different genres of technical writing. * Develop a project plan for a technical writing document and track progress against that plan. * Describe the processes used for reviewing and editing technical documents. * Describe the appropriate use of social media to distribute or draw attention to technical documents.
Research Techniques for Technical Writers
30
Sample learning objectives * List and explain the information gathering techniques used by technical writers. * Differentiate between primary and secondary research. * Describe how surveys and interviews can be used in performing research. * Explain the importance of sample size, response rate, and selection techniques in developing or identifying relevant and reliable surveys and interviews. * Identify examples of survey research that lacks validity due to poor methodology or low response rate. * Explain the proper techniques for identifying and interviewing subject matter experts. * Explain the use of on-site research techniques (field, lab, or simulation) to collect and validate information. * Explain the role of using a product to inform technical writing. * Identify types of reference materials that are reliable sources of information. * Differentiate between causality and correlation and provide examples of research materials that inappropriately attribute causality where mere correlation exists. * Demonstrate the ability to conduct a search for valid, accurate, and reliable resources and references. * Demonstrate the ability to identify potential sources of error or inconsistencies in resource materials and references. * Explain the challenges and limitations of using scientific models to predict outcomes. * Use proper format to cite resources and references in work. * Explain the relevance of statistical significance and identify examples of research findings that meet acceptable standards for statistical significance.
Using Visual Images to Communicate Technical Information
30
Sample learning objectives Explain the importance of using tables, charts, graphs, Gantt charts, diagrams, and infographics to provide clear and concise information. Differentiate between the various types of graphics that are used to convey information. Interpret simple and complex graphics. * Explain the benefits and disadvantages of different types of graphics used to present data. * Explain the process for selecting visuals based on a document’s purpose, audience, and situation. * Develop proper labels and captions for visual images. * Use Excel to create data tables, PivotTables, and graphics. * Describe the ways in which colors and fonts can optimize visual images. * Demonstrate the ability to insert diagrams, tables, and figures into electronic documents. * Explain the ADA Section 508 compliance requirements and the importance of using visuals that meet those requirements.
Document Design and Layout
35
Sample learning objectives * Identify target audience and explain key considerations in developing written materials that serve the needs of the target audience. * Describe the strategies for creating well-organized, visually appealing, and userfriendly documents. * Create templates for memos, employee manuals, technical manuals, flow charts, grants, and policy manuals. * Describe the basic format for training manuals and demonstrate the ability to use software tools (Microsoft Word, Adobe Acrobat, etc.) to create documents that are searchable, contain tabs, a table of contents, and are properly indexed. * Demonstrate the ability to break long topics into consumable sections. * Demonstrate the ability to use software tools to design and create publicationquality documents. * Demonstrate the ability to insert images, tables, graphics, and figures into publication-quality documents. * Demonstrate the ability to create electronic documents that are properly tabbed, indexed, and searchable. * Demonstrate the ability to set up and/or post documents to organizational websites. * Demonstrate the ability to obtain final approval for technical documents. * Demonstrate the ability to finalize and distribute technical documents.
Technical Editing
20
Sample learning objectives * Describe the levels of editing and how they are applied to technical documents. * Describe the different kinds of usability testing available to technical writers. * Demonstrate the ability to use and interpret appropriate style guides, editing techniques, terminology, abbreviations, and symbols. * Demonstrate the ability to use Cloud based or other document sharing systems to edit technical documents. * Discuss the techniques used for effective collaborative writing and editing.