Tag Archives: Tips and tricks

UX Review: Emergency Measures

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 … Continue reading

Posted in Articles, Beginner Tips, QA | Tagged , , | Leave a comment

Quick Writing Tip: Don’t Add Images Until the Text is Done

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 … Continue reading

Posted in Beginner Tips, Technical Writing, User Manuals | Tagged , , , | 1 Comment

No Spec? No Problem: Testing When Nothing’s Written Down

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 … Continue reading

Posted in Articles, Beginner Tips, QA | Tagged , | Leave a comment

Screen-Cap Tips for Beginners

If you’re starting out in technical writing, here are some things to consider when adding screen-caps to user manuals and training guides.

Posted in Articles, Beginner Tips, Technical Writing | Tagged , | Leave a comment

Understanding Last Week’s Notes

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 … Continue reading

Posted in Articles, QA | Tagged | Leave a comment

How to Get From Zero to User Manual

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 … Continue reading

Posted in Articles, Beginner Tips, Technical Writing | Tagged , | Leave a comment