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.
You're trying to get feedback on your documentation from customers or
from internal reviewers? If you want feedback from customes, then I
would recommend a separate initiative to encourage customers to contact
you. I heard a speaker from Cisco's documentation department outline
their strategy, which I thought was excellent.
If you want feedback from internal reviewers, then given the
documentation's current form, I suggest having them review PDFs using
Acrobat 7.x features. The reviewing features are "free" once you have
Acrobat Pro to create PDFs.
If you're set on wikis, then I'm sure most wikis allow you to create a
page in HTML. Unfortunately, that means you have to edit it in HTML as
well. You may be able to write a script that converts HTML to "Wiki
language".
I think the PDF route is the most cost-effective. Even if you don't
currently have Acrobat, your company would spend much less by buying it
than by having its writers and engineers spend hours searching for and
customizing an open-source solution.
My motto is "There is no such thing as a free lunch!" You do have to
prove this from time to time, by comparing the cost of people's time to
the cost of software. An important corollary, though, is "some lunches
are not worth their cost." For example, Microsoft software (IMHO) is
often overpriced and "under-functioned."
Joe
Joe Malin
Technical Writer
(408)625-1623
jmalin -at- tuvox -dot- com
www.tuvox.com
The views expressed in this document are those of the sender, and do not
necessarily reflect those of TuVox, Inc.
-----Original Message-----
From: bounce-techwr-l-216553 -at- lists -dot- techwr-l -dot- com
[mailto:bounce-techwr-l-216553 -at- lists -dot- techwr-l -dot- com] On Behalf Of Brian
Shaw
Sent: Tuesday, July 19, 2005 10:28 AM
To: TECHWR-L
Subject: Oh so many wikis
Hi,
I'm looking for some advice, and knowing the depth of knowledge and
understanding on this list I thought this would be a good place to
start. I've been researching the use of a wiki for obtaining feedback
for our documentation, but it would seem from what I can determine that
most seem to require users to create the content in the wiki.
Presently, we create all of our content in FrameMaker 7.1 We then create
PDF to allow users to print, and use WebWorks Publisher to create HTML
Help. We would prefer to continue with these tools for our formal
documentation. Our need then, when using a wiki, is to be able to import
already prepared documentation, without losing all of the cross
references within the documentation set. Ideally, we would like to
import the already prepared HTML Help, and make this editable in the
wiki. There are many, many wikis from which to choose, but in looking at
the feature sets of those that I have examined, I don't see any
references to this kind of import.
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.