Help+Manual News

Archive for category Documentation Authoring

Premium Pack 3.46 Maintenance update

Version 3.46 of the Help+Manual Premium Pack add-on is a general maintenance update including fixes for minor issues and some fine-tuning improvements.

How to Get the Premium Pack Update:

You can download and install the updated version with the credentials you received when you purchased. If you no longer have this please contact support@ec-software.com and we will help you out. See the Premium Pack product page for more details on Premium Pack 3 and visit our online store to purchase.

Toolbox utility

  • The Normalize Styles tool failed to identify some styles as paragraph styles and incorrectly reported that the style could not be found. The affected styles were styles based on other styles without explicit paragraph attributes of their own.
  • Some HM projects converted from Help+Manual 4 would cause Toolbox to crash and close when they were opened.
  • The Add/Remove Topic ID Prefixes function failed without completing on some projects with an unusual combination of settings.
  • The Rename Variable function didn’t update the display of the new variable name in some projects.

V3 WebHelp Skins

  • In the layout tables function the style name for identifying layout tables has been changed from layout-table to layout_table. This was necessary because you need to define a project style for this and Help+Manual no longer permits the definition of style names with dashes in the project stylesheet. Old projects using the hyphenated style name will still work; you just can’t create new styles with hyphens. The tap images function is not affected because the style for that does not need to be defined in Help+Manual.
  • Focus is now automatically set to the search input field in the Search pane whenever it is displayed.
  • User-defined menus in the page header would sometimes extend beyond the edge of the page.
  • If you are using Google Analytics, topic pages opened from search results or the keyword index will now include the search text or index keyword in the tracking reference. For example, if the user searched for red widgets or used the red widgets index keyword and clicked on the Introduction topic the tracking reference will be introduction.html?q=red+widgets (?q= is the standard reference for search terms in GA). You can turn this off with the new URL_QTRACKER configuration variable.
  • If you are using a non-standard port (anything except port 80) for your web server the permalink function will now include the port reference in the permalink to prevent the URL from being invalid.

V3 eWriter Skins

  • Focus is now automatically set to the search input field in the Search pane whenever it is displayed.
  • User-defined menus in the page header would sometimes extend beyond the edge of the page.

V2 Webhelp/eWriter skins

  • Focus is now automatically set to the search input field in the Search pane whenever it is displayed.
  • The Open topic in a new tab function displayed an incorrect message that the topic is already open in a new tab on some touchscreen Windows devices (MS Surface and similar).

No Comments

HelpXplain Animated Infographics Beta Program

Try out HelpXplain now by joining the beta program

HelpXplain is an exciting new program from EC Software that takes the pain out of making HowTo tutorials and other animated infographics for the web. You can see some examples and join the beta program here:

http://helpxplain.com/

HelpXplain takes the pain out of making HowTo tutorials

HelpXplain can make a whole range of different web-based infographics, but for documentation authors its ability to make animated HowTo tutorials is nothing short of revolutionary. Instead of trying to get every step of a “performance” right you just make a series of screenshots that the program then links together in an editable screencast with an animated, editable mouse cursor. Let me put what this means this into perspective from the point of view of a documentation author.

From typewriter to word processor

I’ve been working with HelpXplain for a while now while writing the help for it. For me as a help author there is one aspect of it that stands out from all the others. It reminds me of the huge aha experience I had the very first time I saw a word processor. The one thought I had was: “I am never going to have to retype anything ever again.” That was huge. For writers of all kinds, it is still 99.9% percent of the benefit of using a word processor instead of a typewriter. Everything else that modern writing tools do is nice to have, but all those additional functions are still nothing compared to the ability to edit and change your text without retyping everything.

From video screencasts to HelpXplain

HelpXplain is the first time that I have had a similar experience as a documentation author. It is really comparable. Like everyone else, I experimented with using video screencast tools like Camtasia and Captivate. Like everyone else outside of very large, very rich companies, I abandoned them very quickly. They only make sense if you have a huge amount of time to work on little video tutorials, and if someone is willing to pay you a reasonable hourly rate for that time. Both of those things are simply unrealistic expectations for most technical writers working in today’s market. It just doesn’t happen. You’re not going to have that much time to work on a tutorial, and even if you do nobody is going to pay you for it.

Video: When you had to do it just right

But that’s not the only problem with video screencast tools: They are very stressful and thus unpleasant to work with, because you have to get everything right. If you make a mistake while making the video you have to start again. And again. And again. And again. And if you ever need to add something you have to remake the entire screencast. Again. I found this so unpleasant that I would do pretty much anything to avoid having to make video tutorials even if I did have the time and reasonable payment for them. To be honest, I would probably even pay to not have to make them.

HelpXplain: Work at your own speed, correct later at leisure

That is why HelpXplain is such a revelation for me, personally, quite separate from the fact that this is an EC Software product. Once you get the hang of it, making little HowTo tutorials is literally as easy as making a series of screenshots — which is what we are doing anyway. And it is completely stress-free: I don’t have to get my timing right and I don’t have to worry about needing to set up everything right. Between screenshots I can take my time to make any changes I want in the program. And not only that: If I ever need to change or add something I can do that at any time, without having to redo the whole thing.


HelpXplain New Dialog

There is no doubt that making tutorials with HelpXplain is radically faster and more pleasant than struggling with a video screencast tool. In fact, for myself, I could say that it is infinitely faster, because with HelpXplain I am actually making the tutorials, whereas with video screencast tools I wouldn’t be making them at all. Not in the real world.

HelpXplain can do a lot more. But if you’re a documentation author, taking the pain out of making HowTo tutorials for documentation simply makes it a must-have.

Tim Green

No Comments