06
Jan
Jan
An Audience Analysis questionnaire is a set of questions designed to understand the target audience for a technical document. It helps writers tailor the content to the needs, interests, and knowledge level of the readers.
04
Jan
Jan
Identifying the right technical documentation software for your department can be overwhelming. To address this, the following checklist identifies some of the key criteria to consider when selecting technical documentation aka tech authoring software. The list is not exhaustive, but should give you a starting point to assess the products.
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.
In part 3 of this CHAT-GPT writing tutorial, we’re looking at how to use Chat-GPT to refine the first draft of your summary, especially those of a technical nature.
Let’s now look at how to write the actual prompt to summarize the text.
After you’ve uploaded the material to Chat-GPT/Claude/Poe, you must write a prompt (actually a series of prompts as can refine the summary results as you progress).
The simplest way to do this is to ask Chat-GPT how to create summaries, which is what I did.
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.
10
Jun
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.
05
Apr
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.
31
Oct
Oct
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 […]
01
Nov
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 […]