Search This Blog

Showing posts with label HATT. Show all posts
Showing posts with label HATT. Show all posts

Thursday, March 7, 2019

Unbelievablly Cool to Consider

Today, bright & early on a Thursday, I read a post on the HATT list from yesterday. The post was a message from "Lea Rush" who is a Senior Software and Documentation Specialist at Astoria-Pacific, which is located at 15130 SE 82nd Drive in Clackamas, OR. [website: www.astoria-pacific.com]. Her post:

I’ve been using Framemaker 8 to publish compiled HTML help for a long, long time. My office is about to be universally updated to Office 365, and it will include Publisher. With the update model for Win10 changing to continual updates, I suspect that the day in which I can no longer baby along my ancient Frame installation is fast approaching. I’m exploring my options for future documentation support.

The biggest hurdle is conditional text. Most of it is fairly granular, down to individual words. Does Publisher have anything like that? Can it do compiled HTML in the first place?

I wrote back the following:

Greetings from Coralville, IA!
I’m not seeing the connection between MS Publisher & FrameMaker so I’m curious. Why do you think MS Publisher is interlinked with FrameMaker? MS Publisher is a tool to create brochures, business cards, calendars, greeting cards, labels, newsletters, and postcards*, but at least on the surface has very little to do with generating CHM files. I also happen to have FrameMaker installed on my laptop, but I am not actively using it. I use RoboHelp 2015 to generate browser-based help for disaster recovery documentation.

I hope to learn something new about MS Publisher & FrameMaker that I never knew before!

My blog: http://prhmusic.blogspot.com
Me Playing Drums: http://prhmusic.blogspot.com/p/videos-of-me-playing-drums.html
My Favorite Band: Bayside Gabes Iowa City 2019-01-30
Twitter: @prhmusic


*Yes, fine. I admit I opened Publisher 2010 (what I have on my laptop) and transcribed the options in the “Most Popular” section – I don’t have a reason to use MS Publisher ever…

But then I asked myself some questions:
  1. Where is Clackamas, OR?
    • I found out it is near Portland, OR.
  2. How long would it take me to drive to Clackamas, OR?
    • Per Google, anywhere from 28 -30 hours.
  3. What famous bands are from the area?  
    • There's a list from Wikipedia on another post - it was quite impressively long!
So, yeah, that's how my Thursday AM is starting.

Wednesday, September 27, 2017

I'm Clueless

Someone on the HATT list asked for guidance regarding documenting APIs. Catherine responded with this link, which I think is going to helpful someday: Documenting APIs: A guide for technical writers

Tuesday, April 8, 2014

Nearly a Week Hold, but ... you know

"You must be busy" an editor once wrote to me as a lead-in to why he wasn't going to publish the column I had just submitted to him. And it's true - my mind has not been focused on writing blog posts here. Life in 2014, especially with Alex's Babe Ruth baseball season about to ramp up with his first practice tonight, is only going to become more busy as April unfolds in front of me. Sometimes, things slip through the cracks, like this exchange on the HATT list that is almost a week old. I just came across it in my Sent Items while looking for something else and so, before I moved on to other things, I wanted to get this preserved as a blog post for my own future reference.
|
On 4/2/2014, Ari wrote:
 
Does anyone have a chart that compares SmartDocs, Doc2Help and Flare for SINGLE SOURCING (not for Helps)? I have yet to see a third-party, objective chart that includes all three.

As a sole TC at my company, I am evaluating options for single-sourcing our Word-based user software documentation (with PDF output, no Helps at this time), and whether to leave the content as Word-based). I will be trying out the trial versions of these products in the coming weeks. (I do have FrameMaker and RoboHelp experience but do not plan to use these.) 

I responded with this:
|
Ari,

I don’t have a chart to send you. I used the trial version of D2H a couple of years ago and sat in a demo of SmartDocs at the 2012 WritersUA conference in Memphis, TN. Most of our legacy docs are in Word so I was looking for the same type of solution. I have received a lot of emails from Flare touting their single sourcing abilities, but did not install the trial.

I did spend some time with Doc-to-Help and was able to tag content for a specific user guide output – so it worked fine. There were test projects on their website and that helped me out a lot in addition to how their staff went above and beyond what I would have expected them to do for me using the software on a trial. I would recommend Doc-to-Help.

That’s not to say the SmartDocs people were not very good and accommodating as well. I know they are getting ready to release a new version that touts many new features so I wouldn’t rule them out. The thing I remember about SmartDocs is that they didn’t have a built-in way to generate browser-based online Help so if you think that is going to be a future requirement, you may need to consider that – I have no idea if they ended up implementing that ability or not.

Our situation is that we had a user guide for System A and we had Client 1. Then we got Client 2 and because there was no single source solution, the previous TWer took the user guide for System A and Client 1, saved a copy of it, and modified it. Like all writers seem to do, when the writer read something that didn’t flow right, it was changed for Client 2. Over time, more and more clients were added and the same workflow of making a copy (as a base) of the Word doc was followed. Eventually, we have ended up with different versions of the same procedure to accomplish a task.

For example, in Client 1’s user guide, you may see this:

Adding a Widget
1.    Go to Path 1 > Path 2.
2.    Click Add.
3.    Enter the details.
Note:  The User ID and password fields are required.
4.    Click Save.

And in Client 2’s user guide, you may see this:

Adding a Widget
1.    Go to Path 1 > Path 2.
2.    Click Add, and then enter the details. The User ID and password fields are required.
3.    Click Save.

This is a simple example and some of the differences are more detailed than my example, but you get the idea. My point is that if your existing content has anything like this, where the same section / content is in more than one document, you will have to figure out the “real” version of that content outside of the tool. I was working on creating a single version of “Adding a Widget” so that content could be placed within all the outputs that need it. The mess I was trying to sort out was very intimidating so if you are going to face that, good luck! <grin>

All that said, we are not going to be using a single source solution with Word. We are moving our documentation to Confluence, which has pros and cons like most tools, and implementing single sourcing that way.

Tuesday, December 31, 2013

Ah, the Good Ol' Days of OV to WinHelp

From: me

Good point Paula – and I totally agree that retyping may be easier in some cases. I wasn’t trying to make a blanket statement that my guestimate of 1 hour would apply to Carrie’s content.

In fact, now that you mention it and I reread my post, there was no way you could have known that I was remembering 10+ years ago when I worked for a different employer. One of my projects was to convert hundreds of OfficeVision (an AS/400 word processor) documents to Word / WinHelp. That was when I ended up with a master.cnt file and 100 .hlp files, when it was all said and done. I don’t know if you remember that, but a lot – and I mean A LOT – of people on HATT helped me through that conversion, like Char, Rick Stone, Paul O’Rear, Bill Swallow, and you. <grin> Please, don’t be insulted if I didn’t specify you in that impromptu list!

During that conversion, there was a wide range of page lengths. Some of the existing documents were really short – a page – but those counterbalanced the ones that were 50+ pages. I’m remembering a specific existing 65 page doc that was part of that conversion. It had not only content about the menu options that were on the screen, but bundled with it, there were implementation procedures of let’s say 6 steps each. The system I was working with was for a billing system used by telecommunication companies and this specific one had 15 menu options. One of the things I was also dealing with was cleaning up garbage like:

“To run the <State_Name_Calling_Plan> menu option, the user must have authority granted by your system administrator or another authorized user, if you don’t have a system administrator. Running the <State_Name_Calling_Plan> menu option requires that the user has an authority record set up through the Authority Maintenance menu option, which is conveniently located on the System Controls menu. If the user does not have access to the System Controls menu, the user cannot access the Authority Maintenance menu option to set up authority for this menu option – it must be granted by your system administrator or another authorized user, if you don’t have a system administrator. The <State_Name_Calling_Plan> menu option cannot be run during the Billing Cycle. Consult the documentation provided about the Billing Cycle to determine when the <State_Name_Calling_Plan> menu option should be run and what menu options must be run before the user can run the <State_Name_Calling_Plan> menu option. ”

Can you hear that blurb screaming, “Rewrite me! Please! Save me from this dribble! Create snippets about the <State_Name_Calling_Plan> menu option, about Authority Maintenance, about the System Controls menu, and about the Billing Cycle! Please! I’m begging!” I wish I had that source file available to look at, but it’s on a CD-R at my former employer. Cleaning up junk like that is why I wrote, “you guestimate that on average, it will take you 1 hour to convert each “chunk” to your new tool. You came up with that number because you have several long topics that will counterbalance several small topics that will take minutes to convert.”

Anyways, that’s where my head was at when I responded to Carrie’s post.

Happy New Year! We are planning to watch “Grown Ups 2” with our 17 year-old daughter, her friend that is a boy, and our 15 year-old son. BTW, if anyone saw GU2 and thought it was awful – it’s on a bunch of “Worst Films of 2013” lists – feel free to save me! At 44, it’s safe to say my “out all New Year’s Eve” times are over.
<snip>

From: Paula R. Stern

<snip>
The first question is why it would take an hour to convert a chunk of information? If that were true, you could type that chunk faster into a new tool than that estimate. If you really think it would take that long to go from any tool to any tool, that's what I would suggest you do – just go type it over again, given that a chunk really shouldn't be longer than a page (and often less).

Without commenting on what tool goes to what tool – most content can be imported in far less time than one hour per topic/chunk. Honestly, if it would take that long, you could probably export it to PDF (takes minutes); export that to Word – with the latest Acrobat version, what you get isn't that bad - and then import it into RoboHelp, Flare, whatever.

We are in the process of moving one client to RoboHelp – they are using Doxygen at one daughter-company; LaTeX at another. As part of the rebranding, we just took PDFs from each of these outputs, exported that to Word and reformatted it properly according to the new template. A 100 page document (probably around 200 chunks of information/topics), took us less than 5 hours to import and reformat. Importing it to RoboHelp shouldn't take more than 5 hours once it has been properly formatted – if that.

So, I estimate 10 hours – let's double it for argument's sake and to make the math easier. So – 10 hours to import 200 topics comes to 20 topics an hour, or 3 minutes per topic.

Using your equation of 1,000 topics – we're talking 50 hours – or $2,500 – even doubling that – you still come to $5,000. The learning curve for some applications is longer than that. Again, this is a real life, just done example of moving from PDF to a help authoring tool – in this case RoboHelp, though I have no doubt Flare would be just as fast.

I agree that going into AuthorIT would take much longer and be more complicated but if the direction is AuthorIT to RoboHelp (or Flare), honestly, piece of cake.
<snip>

From: Rhonda Bracey

Spot on Paul. And don’t forget the cost of training, and perhaps getting in a consultant to help set up new templates etc. for the new tool. Back in 2009 I wrote a blog post on just this – I still think it’s as relevant today as it was then: http://cybertext.wordpress.com/2009/02/16/the-real-cost-of-new-software/
<snip>

From: Me

<snip>
I realize I am chiming in a bit late, but I wanted to point out the ‘hidden cost’ to converting from one tool to another - the total number of hours you will spend just to get from your current tool to your new tool.

I am using the numbers in this example because I suck at math and I’m knee deep in work so bear with me.

Let’s say your hourly rate, whether you are salary or not, is $50 / hour. That’s the number your employer uses for calculating its salary budget. Further, let’s say in your existing documentation, you have 1000 topics or chunks of text that need to be converted from AIT to RH, Flare, whatever. Further, after analyzing your content, you guestimate that on average, it will take you 1 hour to convert each “chunk” to your new tool. You came up with that number because you have several long topics that will counterbalance several small topics that will take minutes to convert.

So, with your 1000 hours of work, multiply that by your hourly rate ($50) and you get a conversion “cost” of $50,000 and after your employer spends $50,000, they will *just* have your existing content transferred from one tool to another. There won’t be any “normal” updates of your content. The newest feature that all your customers are begging for? It won’t be included. The new topics you are planning to write based upon your Support department’s Top 10 Questions We’re Asked on a Daily Basis – those won’t be done. You will simply have the exact same content you have now but instead of opening AIT, you will open RH, Flare, or whatever.

And, if you fire up your calculator and divide 1000 hours by 40 hours, you’re looking at 25 – 40 hour work weeks that will be spent converting and, really, how many of us spend 40 hours only on a single task? It’s never been realistic in my nearly 18 years of being a technical writer.

Good luck with your situation - I hope it works out well for you. Please keep the list informed of what you end up doing!
<snip>

From: Carrie Zinck

Thank you all for your advice regarding the switch. I’m very interested to see how many of you suggested Flare as a better solution. As I finish this comparison matrix, I’m going to add Flare to the list and see if that might be a better compromise.

I so appreciate you all!

Wednesday, July 31, 2013

Add Comments to Your Code!

Deb Slutzky just joined the HATT list and posted a question about what specific files to provide for her RoboHelp project to foreign companies that will rebrand and translate the user interface and help files for the software she documents.

Colum McAndrew responded with the recommendation to "At the end of the day I wouldn't worry about only providing the exact files. Just give them the source files in their entirety and let them use whatever they need."

And then I chimed in with this:

I agree with Colum - give them every file in your project directory.

I would add that you have the opportunity to make the life of the person that takes your files a little easier by using comments in your CSS and in your HTML files. For example, when I was generating WebHelp to be deployed for a Desktop-based app, I couldn't link directly from a HTML file to a PDF because the PDF didn't have Mark of the Web (MOTW) so I had to create a HTML file for each PDF that simply embedded the PDF file. So, if you look at the code, the syntax to open a PDF would look weird because it was actually linked to a HTML file. I put notes in the HTML file that embedded the PDF. The way that project was structured, any link to open a PDF went to a central "Print Documentation" HTML file so I also added comments in the code on that page as well to explain what was happening. Do the same type of thing in your CSS file to indicate when specific CSS styles are being used. For example, in that same project, I created a span class for each UI element - check box, button, screen, etc. - so that I could control the appearance for every instance of that UI element. If I wanted to make all buttons bold/italic on Monday and then got feedback that they should only be
bold, not italic, I could change the definition for the button class in my CSS file and every instance of button would become bold. You can also include examples in the CSS file that could be helpful.

Even if you are not shipping your project off to be translated, I would include comments in both your HTML and CSS files.

Sunday, September 13, 2009

Different Ways to Access Online Help

What started out as non-scientific observations about how Windows software can access online Help has transformed into assembling opinions from the HATT list.

Chuck Martin brings up excellent points.
It sounds to me like you're limiting the definition of "help" (or capital-H "Help) to something that we might define as a separate system used to display hypertext information. But I think of user assistance as much broader than that.

Nevertheless, some people have noted the F1, something that I'm not sure a lot of users are familiar with anymore, although we as user assistance professionals usually strive to make sure works, at least in Windows applications.

Access to content outside the application window is also often provided by links. Sometimes the links are general. Often they are contextual, frequently asking in the UI text a question a user might have at that point and linking to the answer.

Some applications don't use the word "Help" at all on their buttons or links, having found that users disdain the concept (probably from having been exposed to too many non-helpful help systems, likely as not written by programmers or marketing folk), and choose other terms that users are more willing to click on.

Some applications create a number of access points in the Help menu. For example, direct links to tutorials or getting started content. Some may put a Help item in pop-up menus if it makes sense contextually.

Pop-ups are also a technique used, and there are many variants, from tooltips and other windows that appear from merely hovering, to panes that appear only after a defined user action.


I have seen also, usually in dialog boxes, a separate pane that can be opened as part of the dialog box that contains contextual content.

Sometimes a pane is built in to the UI that contains UA content.

And of course, all the UI content, iconography, titles, and other elements in the user interface give users information.


The always brilliant Rick Stone suggested "Some applications use embedded help where content appears in a specific location within the application."

And yes, I’m more interested in how a separate Help system is accessed at the moment. I've attended the embedded UA sessions @ WinWriters and know how much it rocks. I’m all on board with that.

However, the background of this query is that we are discussing the standards for how Help should be accessed from our systems.

Some of our apps currently do not have any visual cue but if you press F1, you get a window-level topic. Is that the industry standard? Should there be F1 *and* a Help button? Should there just be F1 and not take up “real estate on the screen” with a Help button? Should we do the new Vista standard, which says to not have a Help button and, instead, have hyperlinks that say “Tell Me More About ” as the standard? Do we do that on each field? At that point, isn’t it better to have a single Help button rather than 10 links like that?

The issue I’m really struggling with is that while MS has stated “rules” for how user assistance should be accessed, no one seems to follow them. I get it, on one level, because it means (hopefully) the audience was considered in designing how they would access user assistance. On the other hand, how do you argue a point with an example of having a Help button on the window when the “other side of the aisle” can find counterpoint examples where pressing F1 opens Help and there is no Help button or visual cue?

The following are examples of how Windows apps access user assistance

1. Some MS apps have a ? in the upper right hand corner next to the X that calls window-level help.


2. Some MS apps have no indication that you can get to Help from the window.

which accesses:


3. Some MS apps have a ? icon to the far right on the ribbon


4. Some non-MS apps that run on Windows have a help icon in the lower left corner that calls window-level help.


5. Some non-MS apps have a generic Help button.


Another example:


6. Some non-MS apps have a ? icon to the far right on each module that the program can include. If there is a menu, there’s a Help menu option as well.


7. Dana Worley said, "In our programming software, you can also right-click any parameter to display a pick list of valid options. If valid options do not fall into a discrete little list it will display context sensitive help."
Examples:


Another example:


Another example:


8. David Spreadbury said, "In one application I have developed help for, clicking an alarm in the alarm screen opens the help at the location where the alarm is described providing information on what may have caused it, and possibly a way to correct it."

9. Will Turner said, "Of course, there has been tooltips -- "hover help" -- for many years. Recently, I have been intrigued by Yahoo's use of hover help in the list of company quotes that Yahoo enables me to put on my Yahoo home page. Holding the cursor over a small box next to a stock name yields a pop-up containing several headlines. You can click on one of those headlines to open its details page. I gather that Yahoo accomplishes this with CSS, but I remember reading about the same facility using XML."

10. Some apps only allow access from a Help menu.


11. Some non-MS apps have no indication that Help is available.

So there's some examples... how many zillion more exist?