Information at work.
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. […]
So you’re already comfortable working with code examples in your documentation. Maybe you’ve even read our article about inserting code snippets in Flare with Prism.js. But now that you have a taste of the possibilities that can take your code from boring to beautiful, are you itching for new ways to step up your game […]
When it comes to your HTML output, it can be tricky to insert code that is highly readable, visually appealing, and up to software developers’ expectations. Fortunately, we have an easy way to make that happen! They say that form follows function, but we all want our documentation to be eye-catching. If you work in […]
If you develop customized projects for your clients, you know how important it is to put your experience to good use to avoid starting from scratch every time, even if each project is unique. But if you provide clients with documentation, how do you make sure it’s both unique and adapted to each project, without […]
So, you’ve decided to seek help to produce your technical documentation? Maybe even our article “Outsource or Hire? A few thoughts to help you choose” helped you decide? All you have to do now is make sure everything goes smoothly. Your documentation has to be produced as efficiently as possible and, especially, it has to […]
You may be a small- or medium-sized company, sometimes your technical documentation needs are very big! But are they big enough to hire a full-time writer? Or would it be more cost-effective to outsource your documentation? After all, you call on external resources to design your web site, do your book keeping and resolve legal […]
