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 […]
How to embed CodePen and JSFiddle in MadCap Flare
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 […]
How to insert (pretty) code examples in MadCap Flare
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 […]
Documenting your customized projects: How not to start from scratch every time
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 […]
