#Madcap lingo manuals

#Madcap lingo manuals

Indexes are key features in print manuals - and indexes need to be accurate. You'll want your index words to point to the right pages. Embedding index keywords in topics (rather than just within headings) is critical if you have numerous hotspots on a page or have long pages and plan to generate printed output. I can add index keywords half way through the topic if I want. This is the most important feature for me because I want to single source my content. Although there are still some minor things to edit and check, the Word output is definitely impressive. When I generate printed documentation, the Word output looks almost perfect, especially the numbering and margins. I arranged the numbers in general order of importance. In my system, 5 is extremely important, and 1 is relatively trivial.

I also rated the importance of each item on a scale of 1 to 5. While working with Flare for about a month, I took careful note of all the things I liked and disliked about Flare. I also added quite a bit of content and other enhancements to the help. I just finished converting a help file (which I originally created using RoboHelp 7) into Flare, using version Flare 3.01. When you use Flare to create an actual project (rather than just experimenting with a trial version), you come to know the ins and outs, the major benefits and the quirks, its usability and learning curve, the things you love and the things you hate.

Madcap Flare is one of the most advanced, functionally robust online help tools for technical writers who want to single source their content. Tip: For an updated perspective on this post, see Guest post: 10 New Things to Love and Hate About Flare. Academic/Practitioner Conversations Project.Author in DITA and Publish with WordPress.Reflecting seven years later about why we were laid off.A hypothesis about influence on the web and the workplace.