Technical Writing – andrea lee bishop

Style Matters

Something I learned after a few years of writing books, was how much style mattered in comprehension of technical material. It became the first thing my graphic designer and I worked on when starting a new project. We would do mock-ups, fit the material into the proposed format, and try to think of exceptions thatContinue reading “Style Matters”

Incorporate feedback

Technical writing can be improved so much by interacting with those who are actually using your instructions. Do your customers understand the directions? Do they still have questions? Are you approaching their question the way they would be looking for an answer? Can you explain better? Where do they get stuck? What are the mostContinue reading “Incorporate feedback”

Be Consistent

Another important part to technical writing is being consistent in the way you word and style directions. Having a style guide that you follow will help you immensely. Here is a generic group of steps: In the top menu bar, click FILE > New. Add and edit your content. Click on File -> Save AsContinue reading “Be Consistent”

Be Concise

There are lots of times when I want to start writing something and then I feel like I’m getting too wordy. You want your writing to have personality and humor, but does it belong in technical documentation? I love it when people get to the point. They write as little as possible to convey theContinue reading “Be Concise”