【24h】

Myths and realities of contract technical writing

机译:合同技术写作的神话与现实

获取原文

摘要

These ideas may provide one of the more meaningful sessions that you attend because we are going to be dealing with that thing of IDENTITY. The identity of the independent technical writer. Some of you will want to nod off and then there will be some who will be jumping off your seats. You may react, "No, it's not like that," or query "I've really got to know how your experience compares when it comes to …" (whatever) and out comes a Niagara of questions: your experience, your thoughts, maybe even your outrage.

Let me talk about some of the myths in contract writing and let me describe some realities as I've experienced them. Later we'll discuss their ramifications.

To give you the context for these experiences, let me give the statistics that arise when I tally the projects listed on my resume. Starting in the late '60s, I did programming (three positions), followed by a marketing position where I sold time on an international time-sharing system. Then I made a shift into technical writing. For eight years, I labored as an employee, doing technical writing in a wide range of computer environments.

For the last five years, I've been a freelance writer doing computer documentation in the computer industry in the San Francisco Bay Area. Here is a sample of the types of tasks I've been put to. I've written: manuals to support a product, in house technical notes where one programmer keeps another informed of progress, publicity pieces for trade magazines, a report from corporate management to their backers portraying the concepts and facilities of a proposed product, and several tutorials and quick reference cards.

Not including the range of hardware and software involved, the statistics on these contract jobs may give you a sense of the variety of modes in this work. I've participated in 30 writing/editing jobs of which two were co-authoring, four were editing commercial books and one was a technical review of a commercial book. Of these 30 tasks, 10 were performed at the client's place of business and 20 at my Albany office. Incidentally, there were approximately five failures: false starts where the "client" wanted only an estimate or the company rebudgeted for various reasons. In these five years, I wrote 1054 pages of original material and revised 922 pages. In terms of size, 30% of my tasks were for big companies (more than a hundred warm bodies onsite); 50% of my tasks were for medium sized companies (10 to 100 people); and 20% of my tasks were for small operations (1 to 10 wizards). I began by touting myself as a "documentation consultant;" I settled later simply for "technical writer."

That's a quick "statistical" look at my experience. But what is its soul? Sometimes contract technical writing is viewed as a top-notch rescue operation. What amount of that is myth and what amount is reality? Let's limit our grantedly breezy discussion to some myths clouding these few issues:

the experience you must bring to each task,

the imagethat you project and that the client buys,

the services that you really provide,

the standing you have within the company, and

what attitudes you need for survival and for obtaining nurturance from this line of work.

When we're done, I hope we'll be better able to engender productive attitudes. Those of you who hire independent contractors will be better able to describe your needs and understand the fears and insecurities of the freelancer. Those of you who are freelancers will see the broader picture of where you fit and understand better how to serve.

机译:

这些想法可能会提供您参加的更有意义的会议之一,因为我们将要处理身份问题。独立技术作者的身份。你们中有些人会想要点头,然后会有一些人从您的座位上跳下来。您可能会回答:“不,不是那样的”,或询问“我真的很想知道您的经历在……方面的比较”(无论如何),随之而来的是尼亚加拉问题:您的经历,您的想法,甚至是你的愤怒。

让我谈谈合同撰写中的一些神话,并让我描述一些我经历过的现实。稍后我们将讨论它们的后果。

为了给您这些经验的背景,让我给出在统计简历中列出的项目时出现的统计数据。从60年代后期开始,我做了编程(三个职位),然后是市场职位,在那里我卖掉了国际分时系统上的时间。然后我转向了技术写作。我工作了八年,在各种各样的计算机环境中从事技术写作。

在过去的五年中,我一直是自由撰稿人,在旧金山湾区的计算机行业从事计算机文档的编写工作。这是我已完成的任务类型的样本。我写过:支持产品的手册,内部技术说明(一个程序员可以使另一位开发人员随时了解进展情况),行业杂志的宣传资料,公司管理层给支持者的报告,其中描述了拟议产品的概念和设施,还有几本教程和快速参考卡。

不包括所涉及的硬件和软件的范围,这些合同作业的统计信息可能使您对这项工作中的各种模式有所了解。我参与了30项写作/编辑工作,其中两项是合著,四项是编辑商业书籍,一项是对商业书籍的技术审查。在这30项任务中,有10项是在客户的营业地点执行的,有20项是在我的奥尔巴尼办公室执行的。顺便说一下,大约有五个失败:错误的开始,即“客户”只想要一个估计,或者公司出于各种原因重新预算。在这五年中,我写了1054页的原始材料,修订了922页。就规模而言,我的任务中有30%用于大型公司(现场有一百多个保暖尸体);我的任务中有50%是针对中型公司(10至100人)的;我的任务中有20%用于小型操作(1至10个向导)。首先,我自myself为“文档顾问”;后来我只是为“技术作家”安顿下来。

根据我的经验,这是快速的“统计”分析。但是它的灵魂是什么?有时,合同技术写作被视为一流的营救行动。神话是多少,现实是多少?让我们将轻而易举的讨论限制在一些迷惑这几个问题的神话上:

您必​​须为每个任务带来的经验

您投射的图像和客户购买的图像,

您真正提供的服务

您在公司中的地位,以及

您需要什么态度才能生存并从这方面的工作中获得养育。

完成后,我希望我们能够更好地树立生产态度。雇用独立承包商的人将能够更好地描述您的需求,并了解自由职业者的恐惧和不安全感。那些是自由职业者的人将会看到更适合您的位置,并更好地了解服务方式。

著录项

相似文献

  • 外文文献
  • 中文文献
  • 专利
获取原文

客服邮箱:kefu@zhangqiaokeyan.com

京公网安备:11010802029741号 ICP备案号:京ICP备15016152号-6 六维联合信息科技 (北京) 有限公司©版权所有
  • 客服微信

  • 服务号