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.
Take this as "first cut, thinking aloud", and give me a hand with how to
focus my thinking by giving me some better questions to ask :-) .
I'm working with a small company that makes a software product for a
very specialized audience. Currently the developers have create a User
Guide and some code samples, and have some JavaDoc for the customization
of the product. The product has several components, so the customer can
order different configurations. Doc is shipped with the product, or via
e-mail.
As time goes on, they would like to be able to do the following:
-Allow the customers to access a web site that has material specific to
the configuration the customer uses.
-Update the documentation as a product component changes
-Allow some of the material to be viewed by pre-sales customers.
Right now, these requirements are still forming. But these needs are clear:
Need to
-Manage different versions of documents (both source and final versions)
-Have a mechanism that allows access to groups of documents, controlled
by username/password, or a similar scheme
-A web presentation of information (which can include download of
documents in pdf)
-Simple enough to use that most of the dev team could use it without
extensive training (i.e. can't have to many "tech writer" concepts as
the mental model).
My first round of research suggests that a simple document management
system may be the answer. However "content management" is the new buzz,
so I'm going to look at that as well. However, I am concerned that
content management schemes that I've looked at so far require too much
analysis and design for correctly structuring the content for
reusability. In an ideal world, that's a great goal, but realistically,
there'll probably be several different doc models/designs before we can
settle into the best way to do this. (And there's no dedicated doc staff.)
Thoughts? Issues I should be considering? The scale is that there are
currently about 10 customers, and might be 30-50 within two years.
New from Quadralay Corporation: WebWorks ePublisher Pro!
Completely XML-based online publishing. Easily create 14 online formats, including 6 Help systems, in a streamlined project-based workflow. Word version ships in June, FrameMaker version ships in July. Sign up for a live, online demo! http://www.webworks.com/techwr-l
---
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.