In this week’s technical writing tutorial, we look at how to write a user story. You can use these guidelines and checklists to refine your user stories, expand the material to help your readers understand the scenario, allow developers to code the requirement, and testers to ensure it meets the acceptance criteria. Let’s get started.
Author Archives: Ivan Walsh
Looking for a Quality Assurance Plan template? We’ve spent most of the week polishing this fella and now he’s ready for prime time. See what you think. Quality Assurance Plan Template This template pack includes a 39-page Quality Assurance Plan Template in MS Word, an Audit checklist and Schedule Forms, and 7 Excel spreadsheets. You […]
In the Madcap world of Flare (yes, I promise never to say that again), you can use stylesheets to give your tech docs a real edge. For me, styles are one of the hidden secrets in Flare. So, if you plan to publish your tech docs to PDF, Web, or HTML5, a crash course in CSS […]
Conditional text is one of those writing tactics technical writers love to talk about… but never seem to use. It’s a shame as conditional tagging can save you a lot of time, especially if you have technical documents which share 90% of the content but the other 10% needs to be tweaked for each release. […]
Using Madcap Flare to create your WebHelp? Did you know you can add SEO information to the page headers? This improves their results in search engines queries and helps customers find information faster. Want to know how? Follow these steps, grasshopper. Madcap Flare: how to improve Search Engine Optimization In Project Organizer, click Targets, then […]
Are you using variables in your technical documents? If not, you might be missing out. They save a lot of time and help keep the documents accurate, for example, if you need to change a product name across the entire doc set. If those puppies were hard-coded, you’re in trouble. We use Madcap Flare. The […]