Most user guides fail before the first word hits the page. Writers stare at a blank screen, unsure where to begin. The template sits open. The deadline looms. Nothing happens. AI changes this completely. But only if you know how to prompt it properly. By combining professional templates with a structured prompt library, you can […]
Summary: While Generative AI can accelerate documentation drafting, its output quality depends entirely on the structural constraints you provide. By using a “Prompt Library” alongside professional templates, technical writers can ensure consistency, reduce hallucinations, and adhere to industry standards like the Microsoft Style Guide. You’re staring at a blank document. The deadline looms. Your brain […]
This tutorial from the technical writers at Klariti shows you how to use MS Word’s Document Properties (metadata).
In this article, I compared 5 different LLMS to see which is best are reviewing long documents over 100 pages.
Last week, we went to IKEA to get some new equipment for our home office. In this Klariti tutorial, we look at how to write an installation guide that makes the assembly experience as smooth as possible, and include a series of checklists you can follow to ensure you’ve covered all points.
Remember, consistent practice is key to improving your proofreading skills. In addition to the above suggestions, I’d suggest that you look at proofreading as a separate task in the document development process.
For example, if you use software like Jira/Trello to manage your writing projects, add a specific ticket for proofreading. This ensures you carve out enough time to perform this task before you send the documents out to customers.
When writing requirements or technical documentation, when should you use Will or Shall? Does it make any difference which term you use? Yes. Writing Requirements: Will v Shall v May Let’s look at when you use each. Will indicates intention. “I will fix this PC” (you intend to) “Shall” indicates obligation. It’s close to a […]
In the last tutorial, we looked at how to write work instructions. You can also create a worklist for work instructions according to the following criteria: Data on the work instructions, such as: Plant in which the work instructions were created Number of the set of control instructions from which the work instructions were generated […]
