Category Archives: Beginner Tips

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

Lessons I Learned as a Tester, 3: Chinese Whispers Are no Basis for Testing

Written in collaboration with Efrat Wurzel The basic premise of QA is that developers – being human – make mistakes; but too many testers think that developer mistakes are limited to the code they write. The truth is that developers … Continue reading

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

Lessons I Learned as a Tester, 2: Sanity is Relative

The further away you are from the QA department, the looser the definition of version sanity. By the time you get to the back of the development department, where the newbies sit, the definition of sanity is “compilable”.

Posted in Articles, Beginner Tips | Tagged , | Leave a 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

Writing for How-To Videos, Part 1: Basic Considerations for Scripts

Two notes before we begin: first, this article is about software how-to videos, not instructional videos that explain a subject or your business plan. Second, this is the first article of two. I’ll present some basic considerations in this one, … Continue reading

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

Lessons I Learned as a Tester: Don’t Let Developers Go Crazy With Testing Instructions

When asked to provide testing instructions for a new feature or bug fix, there are three types of developers: some are surgically precise, some are fairly precise while erring towards caution, and some give the widest set of instructions they … Continue reading

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

Questions to Ask Yourself Before Writing an FAQ

Some technical writers hate FAQs. I rather enjoy them, because they’re the only bit of technical writing most people will ever bother reading. But they’re not always an easy thing to write; since FAQs are never full explanations of the … Continue reading

Posted in Articles, Beginner Tips, Technical Writing | 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

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