Tech Write Tips

July 6, 2006

Best Pratice: Flare 1 – Reporting

Filed under: Best Practice,Madcap Flare,Tool — AndyR @ 12:32 pm

The first of our mini-series of tips for Flare, here we consider how to leverage that old RoboHelp licence to squeeze some extra information out on your Flare HTMLHelps. 

It is advisable to ensure the following checks towards the end of a help project:

  1. Technical correctness check by Designer
  2. Help integrity checks by Technical Author
  3. Grammatical check by Proof Reader
  4. Accessibility check by the Tester
     

The second stage here requires a high degree of reporting information. To aid us with this we need to leverage functionality in RoboHelp until the reporting in Flare is updated. The following process enables you to gain a whole host of additional information about your Flare HTMLHelp project. Perhaps you CAN have your cake and eat it:

  1. Towards the end of your help project in flare.
  2. Generate output and save a log of the issue as a report.
  3. Run through this report, correcting the errors.
  4. Generate output again.
  5. Take a copy of the temporary output from:
    1. PROJECT\Output\USER\Temporary\Microsoft HTML Help\Content.
  6. Open the _Temp.hhp in your legacy copy of RoboHelp.
  7. Work through the topics in the RoboHelp Broken links section to fix links back in flare.
  8. Select the TOC in Robohelp, check through the list for topics not included in the TOC. Add these items into the TOC back in Flare as appropriate.
  9. Select Tools | Report in RoboHelp and use any additional reports to check content.
Advertisements

14 Comments »

  1. […] This is the third in a series of post about how to get the most out of Madcap Flare. We’ve look at Reporting and  Topic Titles, now a little post about the flexible user configurable layout. […]

    Pingback by Tech Write Tips » Flare 3: Custom Layout - How do you use yours? — July 12, 2006 @ 12:40 pm | Reply

  2. I had a request from my Development Team for a list of files (external pages, files on our ftp server, etc) which I’m linking to in my Help files. I noticed that in Flare when I insert a new hyperlink to an external Website that there is a list of recently used (or existing) links to choose from. Is it possible to have Flare generate a list of these external links in any way? I wasn’t able to find a way in the Help files or a post about it on the forum, but I wondered if there was some way to generate such a report.

    Comment by SeanPAS — January 25, 2007 @ 9:30 am | Reply

  3. I do this by opening my flare output in RoboHelp then using Tools | Reports | External Topics to generate a list.

    Opening a flare project in Robohelp is pretty easy. I Put a post together about it here:
    https://techwritetips.wordpress.com/2006/07/06/best-pratice-flare-reporting/

    Let me know how you get on.

    Comment by AndyR — January 25, 2007 @ 9:31 am | Reply

  4. can u elaborate more on technical writing

    Comment by shalaka — March 19, 2008 @ 10:20 am | Reply

  5. tell more technical writing

    Comment by shalaka — March 19, 2008 @ 10:20 am | Reply

  6. welcom to yor foolong to vere good

    Comment by wael elkady — September 6, 2008 @ 3:57 pm | Reply

  7. Please correct the typo “Pratice” to “Practice” at the top: “Best Pratice: Flare 1 – Reporting”

    Thanks!
    Nalin

    Comment by Nalin — October 28, 2009 @ 2:42 pm | Reply

  8. Please, tel me how shall i writ an booking letter to some organizations.

    Comment by Gobinda Bose — April 19, 2011 @ 7:42 am | Reply

  9. can you write crittical thinking

    Comment by shameem javahar — July 31, 2011 @ 11:09 am | Reply

    • yes i am feel vary bad……………………………

      Comment by pamooru thulasiram — February 16, 2013 @ 11:43 am | Reply

  10. simply,best

    Comment by Menu Swathi — August 11, 2011 @ 6:13 am | Reply

  11. very nice and simple…
    Thanks.

    Comment by Rahul — March 23, 2012 @ 8:33 am | Reply

  12. very nice and simple…
    Thanks.

    Comment by Rahul — March 23, 2012 @ 8:35 am | Reply


RSS feed for comments on this post. TrackBack URI

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

Blog at WordPress.com.

%d bloggers like this: