Skip to main content
TrainingLisa
Participant
January 21, 2013
Question

Help with standard guidelines

  • January 21, 2013
  • 4 replies
  • 720 views

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??

    This topic is closed to new replies. Start a new post to keep the conversation going.

    4 replies

    TrainingLisaAuthor
    Participant
    January 23, 2013

    Thanks for the response Andrew.  At the moment they are doing a direct copy and past of the user manauals, including all screen shots.  We have requested context sentive help that the using can access while they are in the application.  Does this sound right to you?  Also, we have two different formats for our manuals.  We have been told that the format in help will be different depending on which manual is being copied. 

    Peter Grainge
    Community Expert
    Peter GraingeCommunity Expert
    Community Expert
    January 24, 2013

    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

    Use the menu (bottom right) to mark the Best Answer or Highlight particularly useful replies. Found the answer elsewhere? Share it here.
    RoboColum_n_
    RoboColum_n_
    Legend
    January 25, 2013

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

    RoboColum_n_
    RoboColum_n_
    Legend
    January 22, 2013

    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.

    Terms & ConditionsAccessibility statement
    Using the community Terms of use Privacy Cookie preferences Do not sell or share my personal information ad choicesAdChoices