Ten Tips for Using Flare

In no particular order, some tips for using Madcap Flare. When creating your documentation – think Conditions! Is your document intended for more than one type of user? Are you supporting more than one version, multiple but similar products, text that is reused? If yes, the answer may well be Conditional Text. Use multiple tables of contents – using more than one TOC enables you to organize help or printed documentation in a different order, each best suited…

Comments Off on Ten Tips for Using Flare

What Name Shall I Name?

It's really easy for users to know what something is called in the product they are using. They just have to read the documentation...right? The problem is...how did that name get in the documentation? Is it the right name? As technical writers, we know that sometimes we can ask the marketing department; sometimes we can ask the developers. But when you live in a place where the language of the product is considered the second (or third or fourth…

Comments Off on What Name Shall I Name?

Managing a Global Team of Writers

I had the pleasure of presenting at TC World/TEKOM in Stuttgart last week. I've been to several international conferences in the last few years. In some cases, I was impressed; sometimes I was a bit disappointed. Often I felt very proud of our own conference here in Israel (MEGAComm). The audience in Stuttgart was respectful, interesting, engaging. It was interesting presenting to a global audience, discussing how global teams should work. Here's the presentation:  

Comments Off on Managing a Global Team of Writers

What Agile Brings to the Company…and to Documentation

An Agile environment offers many benefits (and challenges) to the company, to the technical writers, and to end-users. It is, without doubt, a challenge in and of itself because each sprint, each chunk of time between deliverables is much shorter than in a standard, non-Agile development cycle. Where once we planned 6-8 months ahead (and sometimes even longer), now we speak in intervals of two weeks to four weeks. We don't speak of dozens of new features, but…

Comments Off on What Agile Brings to the Company…and to Documentation