Category Archives: Technical Writing
Jun
Can CHAT-GPT write technical documentation? Like many tech writers, I’ve been looking at ways to use CHAT-GPT, Huggingface, and Google Bard to help with tech doc tasks.
Apr
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.
Nov
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 […]
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 […]
