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.
Subject:Re: A Long Time Ago From:Jay Maechtlen <techwriter -at- covad -dot- net> To:TechWrl list <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 18 Sep 2007 12:32:06 -0700
John Posada wrote:
>> The importance of the As-Is used to be widely recognized. Now, most
>> seem unaware of As-Is documentation. Indeed, look at the current tool
> Not my experience, both from the standpoint of Use Cases and System Descriptions. The problem with As Is documentation is it must be maintained and it is more maintenance labor intensive than any other type of document. Everytime a change is implement, the As Is stuff must be updated.. Otherwise, As is becomes As it Used to Be.
> At a gig not too long ago, I was brought in to document the As Is. 18 months later, I left them with over 5,000 pages/11 binders....right down to the server and what was on the server, over 67 processes for order fulfillment (it was the secoind largest online book retailer), and database, right down to the server-to-server replication process (over 100 database servers). That was about four years ago. I couldn't even begin to estimate how much of it still resembles the As Is...my guess is less than 10%.
At my last gig, one of the things I did was document a hardware/software
system so it could be moved from a developer environment(in production)
to a production environment.
I set things up so that transient info, like "which app lives on which
server", could be updated by those doing the maintenance for their own
use and convenience. I pointed the main docs at those transient docs
rather than incorporating them. With luck, they may even be maintaining
the transient stuff!
(not my problem, though...)
techpubs -at- covad -dot- net
626 444-5112 office
626 840-8875 cell
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-