22
May
May
In this Klariti tutorial, we look at how to write, review, design and improve your datasheets.
Category Archives: Technical Writing
If you’ve followed the previous steps, you should good technical summary. You should have saved a considerable amount of time, especially if you fed Chat-GPT with material from different documents, spreadsheets, and notes. I suspect doing this by hand would take considerably longer.
Here are some other ways you can get Chat-GPT to improve the quality of the summary.
Recently, I’ve started to use CHAT-GPT as a type of ‘Summary writer assistant’. My aim was to see if it can save me time drafting summary material, speed up the review process, and refine the quality of my own summaries. Does it help? The short answer is Yes.
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.
Samantha from New Zealand asked me last week why the Troubleshooting Guide Template wasn’t for sale on the site. While this Microsoft Word template is already part of the Technical Writing Kit, I understand that not everyone wants all those documents. So, for those who want this document, what I’ve done is create a new sales page and offer it a standalone product.
22
Feb
Feb
So, you want to write release notes but don’t know where to start? Well pull you a chair and let me give you the lowdown. Download – Release Notes template with sample text. Introduce the release notes with text such as the following: These release notes provide information about the documentation for <your product> <version […]
