Skip navigation
TrainingLisa
Currently Being Moderated

Help with standard guidelines

Jan 21, 2013 3:52 PM

Team - Is there such thing as a guidelines document for creating Help?  I have a software vendor developing Help for me (with RoboHelp) for the IT system they are creating.  My concern is they aren't using any sort of recommended format.  It just feels wrong.  Any suggestions??

 
Replies
  • RoboColum(n)
    5,356 posts
    Oct 8, 2004
    Currently Being Moderated
    Jan 22, 2013 9:00 AM   in reply to TrainingLisa

    Not really as it depends entirely on what the requirements are. RoboHelp has a number of output formats it can create as listed below:

     

         http://www.cmcandrew.com/robocolumn/archives/748

     

    Can you give us an idea of which one they are creating and what is wrong with it? Maybe it is just a case of someone giving them a steer on what is required by way of appearance, style, etc.

     
    |
    Mark as:
  • Currently Being Moderated
    Jan 24, 2013 10:01 AM   in reply to TrainingLisa

    It was Colum McAndrew who replied to you. I blame his father for causing the confusion.

     

    It is common for OLH to be created in a way that also generates a manual. How useful that is depends on the volume of text and the audience. If it is a complex application that can be configured in a zillion ways, then it is likely an app for a large organisation and someone there will want the complex explanations to help them write internal procedures. After that then it depends on whether the OLH is required to be exhaustive or whether separate training is available and the help is really an aide memoire.

     

    Sometime an old fashioned approach is still good, sometimes it isn't.

     

    Your knowledge of the users and what is being described has to be how you assess whether the OLH is fit for purpose.

     


    See www.grainge.org for RoboHelp and Authoring tips

     

     

    @petergrainge

     
    |
    Mark as:
  • RoboColum(n)
    5,356 posts
    Oct 8, 2004
    Currently Being Moderated
    Jan 25, 2013 9:22 AM   in reply to Peter Grainge

    LOL! That isn't the first time he has got the blame for things

     
    |
    Mark as:

More Like This

  • Retrieving data ...

Bookmarked By (0)

Answers + Points = Status

  • 10 points awarded for Correct Answers
  • 5 points awarded for Helpful Answers
  • 10,000+ points
  • 1,001-10,000 points
  • 501-1,000 points
  • 5-500 points