Tag Archives: Technical Documentation
Jun
Here are seven quick tips to improve the quality of your technical documents. When you write a technical document, consider the following points:
Jan
1 Minute Writing Tip: Do you need a colon before a list? Or would a comma work instead? Let’s break it down.
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.
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 […]
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 […]
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 […]
