Writing Skills

I have experience in a wide range of different genres and subgenres of technical writing. Every user guide is comprised of different pieces that work together as a whole to give the user the right information, in the right form, at just the right time.

Research

Research is the foundation of technical writing. Whether I’m researching my users with the help of user experience experts, discussing product functionality with the development team, or reading other online help, I’m broadening my knowledge and experience.

Procedures

Procedures are the backbone of user-focused documentation. Clear, concise procedures tell users exactly how to accomplish a task. They include directional information and tips when it’s most helpful, and leave out any extraneous information.

Project Skills
First Generation User Guide Research
Procedures
Troubleshooting Topics
Revised User Guide Research
Procedures
FAQs
Video Script Research
Procedures
Script Writing
Usability Study Research
User Testing
Report Writing
Proposal Research
Proposal
Report Writing

Troubleshooting Topics

When users run into trouble, they expect online help to tell them exactly how to fix their problem. Using a separate section of the documentation to address potential problems that might arise, especially due to human error, is essential to helping users get their jobs done.

FAQs

Sometimes more conceptual information still needs to be included in a user guide, even when I’m trying to keep it task-oriented and user-focused. FAQs are a great way to include this conceptual information while still keeping it user-focused by making sure each question is something a real user would actually ask.

Video Scripts

Different users learn best in different ways. The more flexible my documentation can be, the more useful it will be. Providing short, task-oriented videos to accompany the documentation helps users see what can sometimes be hard to understand in words.

Proposals

Whether proposals are internal or external, technical writers need to know how to persuade their audience. Persuasion and attention to detail is particularly important when I’m responding to an RFP.