TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
I joined a healthcare organization about 8 months ago in the middle of a
software release, and the help system was already in place. Since then the
company has been releasing one software version right after another,
therefore, there has not been enough down time for me to dig deeper into
RoboHELP, and I have never received "formal" RoboHELP training. The other
writer who works with me is in the same boat. Prior to this job I worked
writting engineering manuals translating Assembler code into pseudo code
for powertrain applications.
I know how to insert/edit topics in our existing system, create the help
file, and troubleshoot the MAP files when they get re-numbered, but lately
many programmers has been asking if we can create a Readme file located
outside of the application using RoboHELP, so that it has the look and feel
of our actual help system, this way they can place hyperlinks in the text
rather than have the customer search via Word. I tried to start but I
bombed, I do not know what I did wrong, then a co-worker mentioned that
RoboHELP was an embedded application, and it had to be part of the software
ladscape in order for it to work. If this is the case and assuming that
the Readme file can be created with the use of RoboHELP, how is the
deployment going to take place?