21
Jan
Jan
1 Minute Writing Tip: Do you need a colon before a list? Or would a comma work instead? Let’s break it down.
Tag Archives: Technical Documentation
13
Jan
Jan
Overwhelmed with documents coming at you from all angles? Can’t find that one-liner in a recent email chain? Previously, I used a combination of tools, such as Obsidian, Notion, and Google Docs to get my arms around this. Recently, I’ve switched to NotebookLM and found it much better.
If you’re drowning in a sea of email chains, documents, meeting notes, and other fragments—maybe you work in IT, pharma, or any industry that thrives on information—I’d suggest you look at NotebookLM to coordinate all of this material into a single, coherent location.
27
Feb
Feb
In this MadCap Flare technical writing tutorial, we’ll look at how to add an image to the About box in the output window. When you click the icon, your image is displayed in the corner. A nice touch and a way to highlight your brand. At Klariti, we use MadCap Flare (and Word) to write technical documents. […]
25
Feb
Feb
In this MadCap Flare tutorial, we’ll look at how to start a technical writing project. Here, at Klariti, we use MadCap Flare to write technical documentation for our clients. Contact us if we can help. Download 15 Technical Writing templates to write technical documents faster MadCap Flare: How to Create Your First Project There’s different ways […]
06
Nov
Nov
Let’s say you’ve been asked to document a set of REST or Web APIs, a new area for you. Where do you start? At first this can seem overwhelming. So many new acronyms, terms, jargon, and pieces to fit together. Here’s a suggested approach. Focus on a specific api, for example, REST. Ignore the temptation […]
18
May
May
Summary: Create a preface for technical documents to describe the scope, contents, and materials referenced in the main document. Does a document need a preface? Not always. Short documents are fine without one. However, longer documents, especially those that have changed over releases will benefit from a preface. From one angle, the purpose of the preface is to set […]
