As a technical writer, one of the most important questions you can ask yourself is “what are the default values of the choices a user can make, and why”. For example, if an option is disabled by default, what does that tell you about the average user and their workflow? Are you trying to protect …
Continue reading “Quick writing tip: What’s the default, and why?”
If you’re working on a product and have no particular understanding of UX, you can still do a basic UX review to stop the most obvious disasters. This will not be as good as getting a UX expert or experienced UX-QA to review the product, but it will be much better than nothing.
Here’s a quick writing tip for user manuals: don’t add your images to the manual until you’re done writing your text. This has two advantages. The first is that when you add images one at a time over the long course of writing a manual, it’s easy to overdo it. When you add them all …
Continue reading “Quick Writing Tip: Don’t Add Images Until the Text is Done”
Written in collaboration with Efrat Wurzel Got a new product to test, and the most documentation anyone can provide is an e-mail saying “wouldn’t it be cool if we got drunk and then wrote some code”? Don’t worry – testing without a spec is not quite the disaster you were expecting. Using some exploratory testing …
Continue reading “No Spec? No Problem: Testing When Nothing’s Written Down”
If you’re starting out in technical writing, here are some things to consider when adding screen-caps to user manuals and training guides.
All testers know the feeling: coming in on a Monday, looking at your notes from last week, and understanding nothing. If not for the handwriting, you’d think they were someone else’s notes. How do you write notes that you’ll understand on a Monday, without wasting too much time? Here are some tips, in no particular …
One of the challenges of project work is that you have to get into things quickly and without much help – in many places, people will have neither the time nor the inclination to teach you. Remember that if you want to write about how something works, you have to understand the why of it …
