Should you ever lie or bend the truth in user documentation?

An interesting thread on Twitter from Scott Berkun: I'm increasingly fascinated by this idea. Has anyone seen a designer or organization do something like this? — Scott Berkun (@berkun) October 3, 2019 There are Technical Authors who write “start here”, where there could be more than one place to do it. This is for… Read more »

Importing API reference documentation into a MadCap Flare project

Last year, we blogged about creating an API documentation portal using MadCap Flare (see also: Example of API documentation portal using MadCap Flare). Since then, a number of people have contacted us to ask for more details on ways to do this. We’ve put together a video outlining the different approaches and issues. This approach can work with… Read more »

Managing a project? Need technical writers? Solve that issue today

This is one of our occasional reminders that Cherryleaf offers technical and business writing services. Don’t worry if you don’t have the time or skills to create the documentation in-house. You can use Cherryleaf to create: End-user documentation Online Help Embedded Help Getting started guides Knowledge Bases Quick reference guides Reference manuals Tutorials Screencasts and video… Read more »

In five words, sum up your user documentation/user assistance

We posted a question on LinkedIn and Twitter, “In five words, sum up your user documentation/user assistance”. Here are the replies we received: Utpal Bhatt Technically correct, complete, searchable example   Andrew Lastrina Structured, concise, translatable, unrepetitive, transformable   Dr Meghashri Dalvi Get more out of it!   Aruna Panangipally Makes you effective and efficient!… Read more »

Take part in our survey into the business drivers for technical documentation

We’re running a second survey – this one looks into the business drivers for technical documentation. Whether these factors are important for your particular business. Survey: What are the business drivers for technical documentation? It should take about three minutes to complete. We’ll be sharing our findings on the Cherryleaf blog and Cherryleaf podcast. We… Read more »