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.
Re: Would you like a fries with that style guide, redux
Subject:Re: Would you like a fries with that style guide, redux From:Jo Francis Byrd <jbyrd -at- byrdwrites -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 05 Apr 2001 11:01:04 -0500
I've found this discussion interesting. Only one place I've ever worked has ever
had a style guide. Good thing I carry one around in my head, she noted in a dry
voice. I've helped create style guides and templates as part of a team; I might
note I found the experience frustrating, I didn't agree with many of the
conventions the rest of the team wanted, but, hey, they worked there
permanently, I was just a hired pen.
When working in a team environment having formalized conventions is necessary -
or at least desirable -to produce consistent results. If you have multiple
people each doing their own thing, especially if they are part of the same
project, that's a sure recipe for chaos.
Lone writers, and I usually am, have MUCH more leeway. Yes, I do have certain
conventions I follow. Yes, I do plan my work. Like Alan said, though, I don't
usually write it down (the last time I did was for an HTML help system, and I
wrote out six pages that boiled down to, "don't try this, just call me, it'll be
cheaper and less frustrating for you if you do").
Any writer who can't produce results - GOOD results - without HAVING to follow
written style guides ...well, I have serious doubts as to that person's
capabilities.
Jo Byrd
Alan -dot- Miller -at- prometric -dot- com wrote:
> Andrew:
>
> I agree. It's not just the Plan, it's also Execution. Where I must
> respectfully disagree, however, is that good planning does not hide, but
> almost always shines a bright spotlight on the lazy, incompetent, incontinent,
> etc. members of the team. These guys, after all, are the ones not meeting the
> Plan.
>
> Planning is just another tool in a good writer's kit. I never start a job
> without a Plan--though I rarely write it down (I've had clients that wanted a
> written plan, and I always obliged--hey, they're paying for it), too busy
> getting the job done and paying the bills. Which brings up the issue of
> Priorities--lemme see, should I make a Wonderful Plan (not billable) or write
> the damn manual (billable)? Hmmm. Tough choice.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by DigiPub Solutions Corp, producers of PDF 2001 Conference East,
June 4-6, Baltimore, MD. Now covering Acrobat 5. Early registration deadline
April 27. http://www.pdfconference.com.
---
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.
