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 […]
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 […]
So, you’re ready? You’ve taken a hard look and admitted that your technical documentation could be, well, better? It now seems obvious that asking your tech people to write user guides really is a bad use of their skills? You’ve made a decision: You’re going to hire a professional to produce technical documentation worthy of […]
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 […]
Do you put a lot of effort into finding new customers year after year, but don’t always succeed in building a lasting relationship with them? Let’s take a minute to look over some figures that show why it’s worth investing in customer retention and, especially, how technical documentation can help you do this. It pays […]
