Tag Archives: Technical Writing
Jan
This tutorial explains how to write, format, and publish release notes. It also shares best practices, guidelines and examples from Dropbox and Salesforce.
Apr
Hi, I’m Sean, and today on Klariti, I’ll show you five ways to fix typing mistake in MS Word.
So, if you write a lot and get frustrated that you make the same mistakes, well, the following tutorial, will show you how to automatically fix those typos.
API documentation skills are increasingly in demand as businesses looked to API-ify their product lines.
If you’re interested in learning about APIs from a documentation perspective, I’d suggest you connect with the following tech writers on Twitter.
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.
Sep
Let’s say you’ve been asked to document a set of 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. DOWNLOAD API Reference Documentation Template Get API Reference Documentation Template If your company develops APIs, […]
May
In this tutorial we show how to compare two versions of the same Word document so we can see what changes were made to each document. After comparing the documents, Word shows the differences with revision marks. Knowing how to compare documents can be very useful, for example, when reviewing documents submitted by different writers. Quite […]
Jan
In this tutorial, we look at how to create an index in MS Word. We also explain how to prepare your Word document before you start indexing, the correct way to index items, how to delete an index entry, and how to update the index after you have made changes. Ok, let’s start. So, you’ve […]
Jan
Is an index old fashioned? With everything on the web, do you even need an index? The first thing. Not everything’s on the web. The second: What’s not on the web often needs an index to direct the reader to relevant content. The third: A good index makes good content even better. It won’t save poor writing […]
- 1
- 2
