Concept, task, reference: three types of technical documentation

One of the most important aspects of technical writing is effective organization, which not only improves your content’s quality and ease of use, but makes it easier to revise and reuse. One common method for organizing content is DITA (Darwin Information Typing Architecture): a modular approach to creating content that emphasizes topic-based writing. In topic-based […]


Using content boxes in MadCap Flare: Creating content boxes

When you’re writing documentation, you may want to highlight certain pieces of information with content boxes.  In Part One of this two-part article series, we’ll show you how to design content boxes with HTML/CSS in MadCap Flare. Depending on the project, you may have several types of content boxes that contain different kinds of information. […]


Nobody’s reading your technical documentation? So make it better!

If you’re one to believe technical documentation goes unread, you may well end up wondering what the point of investing time and money in technical documentation is. But what if that’s actually not the right question? Technical documentation isn’t literature As Mark Baker points out in Users’ Advocate: Nobody Reads Documentation, “People read novels. They don’t […]