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.
RE: What Program Do You Use for Software Documentation?
Subject:RE: What Program Do You Use for Software Documentation? From:"Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com> To:"CL T" <straylightsghost -at- gmail -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 22 Oct 2008 11:51:30 -0700
I primarily use a Help Authoring Tool (HAT) called Help & Manual. Here's
a blurb from their web site:
"Help & Manual 5 is a single-source help authoring and content
management system for both single and multi-author editing.
"Working with Help & Manual is as easy as writing text with a word
processor, while all content is saved as pure XML in the background.
"Help & Manual scales from small to really large projects with thousands
of pages and creates Windows help files, Webhelp and manuals in print
and PDF format."
Before using H&M, I used (and was pleased with) RoboHelp. I have been
using H&M for about three years and am very pleased.
Leonard
-----Original Message-----
From: techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of CL T
Sent: Wednesday, October 22, 2008 11:36 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: What Program Do You Use for Software Documentation?
Are you creating Help documentation? Manuals? Any/Everything?
Madcap Flare and (I believe) later RoboHelp both handle/write XML. Since
I'm
working with an archaic version of RoboHelp (the upgrade's in the
works), I
don't know for sure.
In this particular company I use InDesign CS3 for all documentation
(with
occasional RoboHelp). I appreciate ID CS3's power, it's improvements
over ID
CS2 (especially with Long Document handling and lists). I cannot say,
however, that it's a great program for a Tech Writer. If you are
planning on
getting down and dirty with the layout/design aspects of writing, it's
great! If you want to push out documentation quickly and efficiently?
It's
not the right tool.
It has been a great experience to add the software to my catalog. So I
won't
complain too much.
On Wed, Oct 22, 2008 at 12:17 PM, John Posada <jposada99 -at- gmail -dot- com>
wrote:
> XMetal for xml files tied to Documentum for content management.
>
> Why? Because we AREN'T a small IT department.
>
> On Wed, Oct 22, 2008 at 1:22 PM, Paul Weir <Pweir -at- bju -dot- edu> wrote:
> > I just started working as a Technical Writer a couple months ago and
have
> been using Microsoft Word thus far to write user-documentation for a
couple
> of in-house software programs. I have also recently been interested in
> learning more about using XML for this purpose, but am not sure it
would be
> a benefit to me in my small IT department.
> >
> > So, I ask as a novice, what software do you all use for your
technical
> writing and why?
>
> --
> John Posada
> Senior Technical Writer
> NYMetro STC President
>
> 'Half this game is ninety percent mental.'
> -- Danny Ozark, Philadelphia Phillies manager
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> ComponentOne Doc-To-Help 2009 is your all-in-one authoring and
publishing
> solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
> HTML and publish to the Web, Help systems or printed manuals.
>http://www.doctohelp.com
>
> True single source, conditional content, PDF export, modular help.
> Help & Manual is the most powerful authoring tool for technical
> documentation. Boost your productivity! http://www.helpandmanual.com
>
> ---
> You are currently subscribed to TECHWR-L as
straylightsghost -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
> http://lists.techwr-l.com/mailman/options/techwr-l/straylightsghost%40gm
ail.com
>
>
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwr-l.com/ for more resources and info.
>
> Please move off-topic discussions to the Chat list, at:
>http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and
publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as
Leonard -dot- Porrello -at- soleratec -dot- com -dot-
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
