Tuesday, August 29, 2017

A Separate Query to TCS Support

I sent this to TCS Support as well. I don't know if I'll get a response or not...
|
As I was reviewing the RoboHelp help text / documentation, I had a question: are snippets being used?

For example, there are 16 results when I searched for “Select File > Options” in the help system. Is that a snippet?

It would be really awesome for me as a user of your product to have that text also show a screenshot. It would be so easy and a great use of RoboHelp to do some of the single sourcing / snippets / user-defined variable type stuff that the tool can do! You could do that with “Notes” as well. I see all sorts of different way they are formatted. There’s all caps with a colon, there’s all caps, bold / italic with a colon, there’s instances within the same topic where a note is on a separate and also where it runs into the paragraph. I saw another page where there are notes within a bulleted list and the note is indented with the text, except for the last note, which is aligned with the left margin.

There’s also a lot of inconsistency in how the text is written like on http://help.adobe.com/en_US/robohelp/2017/robohtml/index.html#rhsearch=%22NOTE%22&rhsyns=%20&t=book%2Frob_layouts_la%2FGenerate_EPUB_and_Kindle_Book_output-.htm&rhhlterm=%22NOTE%22, in the EPUB resources section.
|
Read this article by Neil Perlin to get an overview of EPUB, RoboHelp’s support for EPUB, and some best practices.
For a list of top features of EPUB, see www.adobe.com/go/learn_rh_blog_epub_en.
For more information on the EPUB format, see www.idpf.org.
For guidelines for creating well-formed and well-formatted EPUB documents, refer to www.adobe.com/go/learn_rh_epub_best_practices_en (Best Practices Guide in EPUB format).
See the blog Digital Editions for information about Digital Editions.
|
You could be much more consistent if you wrote the text like this:
|
To read more information about the EPUB format, RoboHelp’s support for EPUB, and some best practices, see this article by Neil Perlin: http://www.adobe.com/devnet/robohelp/articles/robohelp_epub.html
----------------THIS LINK IS BROKEN----------------To read a list of top features of EPUB, see the website: www.adobe.com/go/learn_rh_blog_epub_en. ----------------THIS LINK IS BROKEN----------------
To read more information about the EPUB format, see the International Digital Publishing Forum: www.idpf.org.
To read guidelines for creating well-formed and well-formatted EPUB documents, see the Best Practices Guide: www.adobe.com/go/learn_rh_epub_best_practices_en.
To read information about Digital Editions, see the Digital Editions blog: http://blogs.adobe.com/digitaleditions/.
|
And, for the Digital Editions blog, the most recent post is from 7 years ago! Is there no other more recent information?!?

And, on top of that, one of the links is broken. This is in the Adobe RoboHelp (2017 release) documentation: http://help.adobe.com/en_US/robohelp/2017/robohtml/index.html#t=book%2Frob_gettingstarted_gs%2FGetting_started-.htm

No comments: