Good technical writing feels like you could have done it yourself. It’s unambiguous, easy to understand, relveant and truthful, which allows you to build trust with your exsiting — and potential — customers.
My portfolio demonstrates an agility with plain language and empathy for my audiences, whether I’m writing end-user manuals, knowledgebase articles, white papers or even marketing content.
Note: The links are to pdf documents that will open in a separate tab.
End-user software documentation
Quick Start, User’s Manual, Knowledgebase
The ongoing goal of this project is to give new and seasoned users a variety of tools for learning and using our software. Because this application is a behemoth in the food-development industry, its users wear all different kinds of hats, from food scientists to marketers to chefs. To be effective, the end-user documentation has to appeal to a wide and varied audience. So I have given them more than one point of entry:
- Quick Starts for the more technically savvy
- A detailed users manual for new users and those who need more in-depth instruction
- A knowlegebase that answers complicated questions the seasoned users might have
Challenge summary:
- Understanding what information the end users require
- Translating wordy and complicated government regulations to plain language
- Making the information easy to find and easy to digest, regardless of audience member’s role
Process:
- Software testing/usage leaning
- Reading, digesting and “translating” the labeling section of the Code of Federal Regulations
- Interviewing sales teams
- Interviewing end users
- Figuring out math (PDCAAS article)
Tools used:
- Microsoft Word
- Adobe photoshop
- Confluence
- Jira
- Camtasia
Audience:
- All levels of software users, from first-time to expert
Here are some pieces from the documentation set:
Quick-start guide: Creating an ingredient
Chapter excerpts from the manual
Knowledgbase articles: Various
White paper
The goal of this project was to steer readers to our software by presenting nutritional analysis options in an honest, up-front and informative manner. This white paper was published eletronically as an eBook and sent to some of the top food manufacturing companies in the U.S.
Challenge summary:
- Understanding the various options for analyzing a food’s nutrient content
- Presenting all the options in an honest, up-front and informative manner without editorializing, but still gently steering the reader to our software
Process:
- Researching regulations
- Researching analysis options
- Writing the text
- Organizing and designing the layout
Tools used:
- Adobe InCopy
- Adobe InDesign
- Adobe Photoshop
- Adobe Illustrator
Blog Post: BE-disclosure vs. Non-GMO labeling
In the food world, there are two prominent, competing and often confusing discussions about bioengineered foods and the legal obligations of food-manufacturers. This blog discussed the differences.
Challenge summary:
- Gaining an understanding of the differences and why they exist
- Being mindful of our audience beliefs about the subject and presenting the information without editorializing
Skills:
- Empathy
- Research
Tools used:
- WordPress
RFP: Structural Edit
This was a request for a proposal written by the VP of Sales. He had me edit it for … everything. In fact, I ended up restructuring the narrative, fixing grammar and spelling errors, removing jargon, changing header fonts and adding some spice.
Challenge Summary:
- We were competing with other companies for an opportunity to work with [well-known Fortune 500 company], so this RFP had to be technically correct but also interesting enough to hold the audience’s attention
Other Writing Samples: Various
Because I have worked at the same software company for 15+ years, I don’t have much opportunity to branch out with my writing there. But, I also freelance now and then. I’ve worked with artists and the City of New York and coffee roasters and small businesses and more.
This page showcases some of my freelance work and a few ads for the software company.
Jill Hohnstein 