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.
C. asked a good question about the pros/cons of including documents in
software builds. I have some experience with source-controlled documents
under four different source control systems--usually this has included the
help only--but has not necessarily been limited to help.
In general, I think it's a good idea to keep documents under source control:
* It reduces issues when multiple people work on a document (although this
is often not a big problem for tech writers).
* It offers a good way to track revisions and create backups.
* Since documents aren't usually critical to the actual _functioning_ of the
product itself*, you can often sneak updates into a build even if the rest
of the code base is locked down for a release.
* It gives you a better idea of what the software developers are up
to--their deadlines, concerns, and difficulties. This can gain you critical
"street credibility" with the developers, which helps build the friendly
relationships that help you get the information you need.
* Source control can actually let you work ahead on issues. You can add
updates to a source-controlled document but it will not be included with a
given build/release until you give specific instructions for its inclusion.
Sure, it costs you some "overhead" effort, but I think it is well worth it.
If you're a tech writer these days, you have to be able to learn new
software products. A source control system is no different and usually isn't
that hard once you learn the basics. Plus it gives technical knowledge (AND
your resume) a boost.
* People may start a philosophical debate on this statement, but that goes
well beyond my intent here. May the philosophically inclined please bear
with me.
Ken Stitzel
Synergetics, Inc. for ITC-NRCS-USDA
Fort Collins, CO
970-295-5461
kstitzel -at- itc -dot- nrcs -dot- usda -dot- gov
SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo
>From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more. http://www.doctohelp.com
---
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- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
