Technical Writer
- •
def
- •
someone who writes user guides and other documents for technical products, including software, applications, or other technical products
- •
puts scientific and technical information into easily understandable language
- •
prepares scientific and technical reports, operating and maintenance manuals, catalogs, parts lists, assembly instructions, sales promotion materials, and project proposals
- •
also plans and edits technical reports, and oversees preparation of illustrations, photographs, diagrams, and charts
- •
- •
skills
- •
- •
- •
understanding of the technologies and tools
- •
word processing — MS Word, Google Docs, LaTeX
- •
documentation software — MadCap Flare, Adobe FrameMaker, Confluence, GitHub, DITA XML
- •
help authoring tools — RoboHelp, Help+Manual
- •
screen capturing and editing — Snagit, Adobe Photoshop, Visio
- •
version control systems — Git, SVN, to manage documentation that changes over time
- •
- •
- •
- •
- •
tools by category
- •
|Category|Popular Software|
|Word Processing|Microsoft Wort, Google Docs, LaTeX|
|Help Authoring|Madcap Flare, Adobe RoboHelp|
|Screen Capturing|Snagit, Greenshot|
|Diagram & Flowchart|Visio, Lucidchart, Draw.io|
|Version Control|GitHub, Bitbucket|
|CMS & Collaboration|Confluence, SharePoint, Notion|
|Publishing and PDF|Adobe FrameMaker, Adobe Acrobat|
- •
- •
- •
