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 […]
In Part One, you learned how to create content boxes for HTML5 and PDF outputs in Flare. In Part Two, we’ll explain some strategies for using content boxes efficiently in MadCap Flare. Adding a content box There are a few different ways to add a content box to the topic you’re working on. To use […]
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. […]
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 […]
As any travel writer knows, readers must be lead to the right destination with suggested itineraries to help them make the most of their trip. The same principle applies to technical writers using the topic-based method. They have to organize the various topics to guide users through their tasks. After all, as Marc Achtelig says, […]
