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: How do you publish your documents, guides or completed help
Subject:RE: How do you publish your documents, guides or completed help From:<jan -dot- arnopolin -at- thomson -dot- com> To:<phanson -at- Quintrex -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 19 Jun 2007 09:26:19 -0500
Paul,
We have scheduled releases, about 4 a year, of our software. We have 27
separate products.
It isn't a question of whether or not coworkers "really" want to know
about updated doc. The documentation is updated when there is a change
in the product. They are informed about both at the same time, usually
via a company-wide email sent by my manager who is the product release
manager.
No, I don't distinguish between "little-used" and "frequently-used"
guides. Some products are more important, as determined by product and
client development, and so are likely to have more improvements in each
release than other products.
I don't send out the update notice emails, my manager does. There's
usually 4 or 5 sent out before, during, and shortly after the GA phase
of the release.
I don't save emails. VSS keeps a record of which documents I worked on
and when, my manager reviews each guide before it's published.
I generally send a daily status email to my manager if I haven't seen
her during the day, but not to anyone else.
If you have more questions, I'd be happy to answer them offline.
Thanks,
jan
Jan Arnopolin
Technical Writer
Thomson Elite
Phone: 312.873.6784
Fax: 312.873.6801
www.hubbardone.com
jan -dot- arnopolin -at- thomson -dot- com
Hubbard One, a Thomson Elite business
-----Original Message-----
From: techwr-l-bounces+jan -dot- arnopolin=thomson -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+jan -dot- arnopolin=thomson -dot- com -at- lists -dot- techwr-l -dot- com]
On Behalf Of Paul Hanson
Sent: Tuesday, June 19, 2007 9:12 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: How do you publish your documents, guides or completed help
This is a new idea to me so I have a lot of questions. I'm trying to
wrap my head around what you do and how much time it would take out of
your day.
Who decided your co-workers *really* wanted to know each time you
updated the doc?
Do you distinquish between "little-used" guides and "frequently-used"
guides?
How many emails do you send in a day?
Do you save all the emails you send to validate your existence - that
you are actually updating the doc?
Do you send one email at the end of the day or after each one you finish
updating throughout the day?
Do you also send out a notice if you update a topic in the online Help?
Can you provide some numbers re: how much time this takes you?
Do your co-workers tell you that they appreciate being told the doc was
updated?
Like I said, new idea to me, trying to wrap my head around it.
-----Original Message-----
From: jan -dot- arnopolin -at- thomson -dot- com
<snip>
When documentation is updated, an email is sent to all employee groups
informing them of the guides that were updated and the location on the
server.
</snip>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats
or
printed documentation. Features include support for Windows Vista & 2007
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 jan -dot- arnopolin -at- thomson -dot- com -dot-
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
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-
