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.
On Wed, 2002-10-09 at 16:20, KMcLauchlan -at- chrysalis-its -dot- com wrote:
> I'm thinking that the Wiki-wiki concept might be
> a really great way to write the Requirements Specification
> and maybe also the Design Spec for an open-source
> project like OpenOffice.
No need to adjust the meds, Kevin. I use Wiki daily for development
process documentation and for maintaining public web site content. Two
very different uses, but the Wiki concept is perfect for both: I need an
environment where folks can work together on content, not worry about
how it looks (no font fondling here), and get it done -- fast.
The original Wiki is nice but I chose a Wiki clone called TWiki
(http://twiki.org) because it had some additional features for my
intranet environment.
Here's how we keep requirements specs in Wiki:
1. I created a template with places to put a requirement name, an
acceptance test, and some other meta-information.
2. With the developers, we sketched out other documents (including plans
for phases of development, release plans, and formal test documents) and
created templates for them.
3. During development, we keep track of requirements, their design, and
testing.
Every developer contributes to the Wiki pages. The documentation is no
harder than keeping text files, which our developers prefer. The
advantage is that everything is public (but internal to the company), so
critique is possible -- and encouraged.
The Wiki is hands-down the best thing I've done to encourage others to
contribute documentation. "Its in the Wiki" is a common prhase among our
developers when someone asks the status of a project. I love it :)
--
Megan Golding SecureWorks, Inc.
Internet security for corporate networks.
No hassles, no headcount, and no capital outlay. http://www.secureworks.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at http://www.ehelp.com/techwr-l
Buy ComponentOne Doc-To-Help 6.0, the most powerful SINGLE SOURCE HELP
AUTHORING TOOL for MS Word. SAVE $100 on the full version and $50 on the
upgrade. Offer ends 10/31/2002 (code: DTH102250). http://www.componentone.com/d2hlist1002
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
