Technical Communication Issues

Is Your Technical Communication Job Affecting your Health?

Could the way you think when creating technical communication be affecting your health? If you find it difficult to relax, are often anxious, and feel extremely risk averse, the answer could be YES. In this post, I’m going to look at how the thought processes we use in our work can become habits that lead to […]

By |June 29th, 2016|0 Comments

Accordion Menu in MadCap Flare – Part Five

This is Part 5 of a series of posts on how to create the following layout, complete with accordion menu and slide-in drill-down menu, in MadCap Flare.

If you missed the previous parts, here are links:

Part One
Part Two
Part Three
Part Four

In this post, I’m going to cover the TopicStyles.css and the Target. I’ll also include so that you […]

By |June 22nd, 2016|0 Comments

Accordion Menu in MadCap Flare – Part Three

This is Part 3 of a series of posts on how to create the following layout, complete with accordion menu and slide-in drill-down menu, in MadCap Flare.

If you missed the previous parts, see:

Part One
Part Two

In Part 3, we’re mostly going to be looking at how to create the master page for this layout, but before […]

By |June 8th, 2016|0 Comments

The Book All Technical Writers Should Read – The Art of Explanation by Lee LeFever

It’s not often that I recommend books to other technical communicators, but I’ve recently finished a book that I think many tech writers can learn from: The Art of Explanation by Lee LeFever. Now before you spit your tea out in amazement, let me just confirm that, yes, the book I am recommending isn’t about […]

By |August 10th, 2014|3 Comments

“Technical Writing’s Dead, Get into E-Learning”

“I can’t believe you are still doing that. Technical writing’s dead, get into e-learning.” Not my words, but the words of a former technical writer who moved on to work in information design. Usually, comments like this are like water off a duck’s back, but this time something jarred with me. So I decided to […]

By |July 12th, 2014|2 Comments

Technical Writing Tools – Do You Need to Know Every Tool?

Have you ever felt yourself becoming overwhelmed with the amount of things you need to learn? Join the club. Since quitting the day job as an employed technical writer and trying my hand at contracting, I’ve been compelled to learn more about a variety of Help Authoring Tools and technical communication principles, ideas, etc.  Like […]

By |June 15th, 2014|9 Comments

A Process for Technical Documentation

When you’ve been a technical author for many years, the process of creating technical communication becomes second-nature. So when a client asked me to draw up a technical communication process, I had to think carefully about each step of the process. Of course, it can vary depending on the organisation, but on the whole, the […]

By |April 2nd, 2014|0 Comments

5 Key Benefits of Topic-Based Documentation

Taking a topic-based approach to your documentation can improve the quality of your manuals and online help, reduce your documentation costs, and make it easier for your writers to produce and update content. This approach is not new, but implementing it with the latest authoring tools, such as Flare, Robohelp, Confluence or an XML editor like […]

By |March 16th, 2014|0 Comments

What is Topic-Based Documentation and How do you Write it?

Topic-based documentation is a way of writing documentation in stand-alone chunks, which are usually stored in separate files (or topics). Each topic focuses on one specific subject, and this applies to pretty much any type of user documentation. To illustrate the point, I’ll avoid the obvious software example and go for something more unusual…let’s say […]

By |March 16th, 2014|0 Comments

How to Interview SMEs (Subject Matter Experts) When You’re Not One Yourself

Are you a technical writer who is struggling to interview SMEs? Are you frustrated that your work is seen as a necessary evil rather than something that adds value to the product? Then this ‘How to Interview SMEs’ article is for you.

 
What? You Don’t Even Know That?!!
Yes, I’ve had that said to me. On more […]

By |December 2nd, 2013|4 Comments

Our Website uses cookies to improve your experience. Please visit our Privacy Policy page for more information about cookies and how we use them. more information

The cookie settings on this website are set to "allow cookies" to give you the best browsing experience possible. If you continue to use this website without changing your cookie settings or you click "Accept" below then you are consenting to this.

Close