Skip to main content
Inspiring
July 28, 2008
Answered

Newbie question: Estimate effort to gen help?

  • July 28, 2008
  • 4 replies
  • 770 views
Hi! I am new to Robohelp; much more familiar with Doc-to-Help!

If I have an existing Word document (say 100 pages), what is the process and effort required to apply a Robohelp template and tweak as necessary to generate basic Webhelp?

1. Apply template
2. Update styles of content, as necessary
3. Generate help
4. anything else?

Any estimates or guidance will be greatly appreciated!

Thanks!

K


This topic has been closed for replies.
Correct answer Peter Grainge
Kathy

Yes both versions can produce webhelp but RH HTML enables you to introduce things that you cannot do in RH for Word. See Twisties on my site as an example.

Also you will get better HTML from RH HTML which while you are a newbie may not bother you, it probably will later on.

Another reason for going with RH HTML is that it is more popular and much better supported in these forums. If you hit a problem with RH for Word, you may not get too many responses these days.

Now let's look at your work scenario. As Colum as said, you can generate a printed document from RH HTML for your SMEs. Whatever document you give them, you aren't going to want to import it back in. Rather you will be making the changes yourself so which version you use becomes academic.

Printed Output does not suggest RH for Word. See the topic on my site about Printed Documentation. That is written for RH HTML and again the control is better, yes better.

Given your familiarity with Word, I do understand your inclination to stay in the comfort zone. I was the same initially but Rick Stone (Robowizard on these forums) persuaded me it wasn't the best way. Sure you are in for a few heartaches but everyone here will help you. With some effort from you, it is not as tough as you probably fear.

4 replies

Peter Grainge
Community Expert
Peter GraingeCommunity ExpertCorrect answer
Community Expert
August 14, 2008
Kathy

Yes both versions can produce webhelp but RH HTML enables you to introduce things that you cannot do in RH for Word. See Twisties on my site as an example.

Also you will get better HTML from RH HTML which while you are a newbie may not bother you, it probably will later on.

Another reason for going with RH HTML is that it is more popular and much better supported in these forums. If you hit a problem with RH for Word, you may not get too many responses these days.

Now let's look at your work scenario. As Colum as said, you can generate a printed document from RH HTML for your SMEs. Whatever document you give them, you aren't going to want to import it back in. Rather you will be making the changes yourself so which version you use becomes academic.

Printed Output does not suggest RH for Word. See the topic on my site about Printed Documentation. That is written for RH HTML and again the control is better, yes better.

Given your familiarity with Word, I do understand your inclination to stay in the comfort zone. I was the same initially but Rick Stone (Robowizard on these forums) persuaded me it wasn't the best way. Sure you are in for a few heartaches but everyone here will help you. With some effort from you, it is not as tough as you probably fear.

Use the menu (bottom right) to mark the Best Answer or Highlight particularly useful replies. Found the answer elsewhere? Share it here.
Kathy2Author
Inspiring
August 18, 2008
Thanks so much for the detailed info! I suppose this means I have to leave my comfort zone!

I appreciate your patience!

Kathy
RoboColum_n_
Legend
August 14, 2008
Hi Kathy.

You can produce Webhelp output from the RH for Word application but most wouldn't want to. The reason is that webhelp is effectively HTM output so why not use an apllication that deals with HTM files. If you need to produce a paper manual you can do so from within the RH HTML application as well. The application has a number of ouptut types that you can generate separately or at the same time.
RoboColum_n_
Legend
August 14, 2008
Hi Kathy.
Peter's question was referring to the two applications that forms part of RH7. Don't get confused into thinking that RH for Word is the same as Word. It uses a Word interface but still requires some knowledge of how RH works. It generates a RTF document that is compiled to produce the output. RH HTML does away with the word interface and uses a WYSIWYG interface that is similar to word in many ways but which generates HTML code.

Both applications allow the import of word documents so if you need other non-technical people to make updates, both applications can be used. However if webhelp is your desired output, I'd suggest you use the RH HTML application. This will make things easier in the long term for you.

I'd suggest you create a test Webhelp project, import a word file and play away.
Kathy2Author
Inspiring
August 14, 2008
Thanks for the info, Colum!

I am very familiar with ComponentOne Doc-to-Help (v6), which starts from Word, using a D2H template. You build a project file, define your outputs, generate a RTF doc, and publish your targeted outputs.

My assumption is that RH for Word works in a similar manner.

I guess my question is why choose RH for Word over RH for HTML, or vice-versa. You seem to have answered that--determined by desired output.

If I start with RH Word, can the project file, etc. then be used in RH HTML? Or would I not want to do that?

The desired outputs are webhelp (which suggests RH HTML) but also--and equally important--a printed manual/PDF (which suggests RH Word).

I will be creating a test project soon--I guess I am looking for guidance so I don't spend too much time heading down the wrong path!

I am leaning toward RH Word because that seems so similar to D2H and allows me to ensure the PDF output's format is clean...

Any further thoughts?

Thanks!

Kathy
Peter Grainge
Community Expert
Community Expert
July 29, 2008
Are you planning on using RH for Word or RH HTML?

The first will automatically apply the template. The latter does not use Word so the question is not applicable. Instead a CSS file will be created and you can then tweak that or substitute your own.

If you are importing into RH HTML, see the Importing article on my site.

Difficult if not impossible to indicate how long as it will depend on the quality of the input document and how quickly you pick up how to use RH.

Use the menu (bottom right) to mark the Best Answer or Highlight particularly useful replies. Found the answer elsewhere? Share it here.
Kathy2Author
Inspiring
August 13, 2008
quote:

Originally posted by: Peter Grainge
Are you planning on using RH for Word or RH HTML?


Peter, first--thanks for your response and sorry for the delay in responding!

Now -- I have looked all over the RoboHelp site and cannot find this info -- is there a comparison of RH for Word and RH for HTML anywhere? Why would I choose to use one over the other?

My thinking is to use Word for the single-source document because the Word doc can be marked up by users without RH access, when updates are required. This is much simpler for non-technical folks than HTML would be!

Also, one of the outputs required is a PDF version of the "Reference Manual" - so I want to ensure that the printed version looks appropriate.

I would appreciate any insight you or other RH gurus can offer!

Thanks in advance!

Kathy