技术写作的恐惧
IntroductionSometimes可能超出预算的公司或个人雇用一名专业作家,以解决他们的技术文档。虽然在一个理想的世界上所有的技术文件必须出示 由训练有素的专家,遗憾的是我们不是生活在一个理想的。以同样的方式,很多人会尝试修复自己的家电,很多人会尝试写高质量的技术文件。 正如一个烤面包机摆弄会导致触电,试图写入未经意见,最终导致失败从头技术文件。根据经验粗略的规定,你应该始终寻求 聘请专家,但如果你因为种种原因不能和你是穷人不幸的是,不得不文件强加给他们的职责,不要绝望。这份简短的指南概述了一些核心技能你会 需要把你的写作,技术公约意识到,软件包可以考虑,明确的事情,就是避免。希望即使你从来没有写在你的生活中任何事情判刑 模糊技术你将有至少,对什么技术写作entails.What更广泛的情况是技术写作?技术写作毫不奇怪的是,指的是书面的技术。虽然 这似乎是一个荒谬的定义,这是一个重要的记忆。太多的技术作者提出了创建文档,要么过于技术性,或太'错误的文学'。一个很好的技术 作者应该能够调整两者之间的,以适应最终用户的文件平衡。技术写作是一种新鲜的空气一样,普遍,但几乎看不见了很多。在有线世界怪异 我们所处的技术写作是无处不在。软件手册,家用电器,教学传单,电子邮件,信件用户指南,报告,技术新闻报道,统计资料和传记的 电视体育节目都是技术,以书面的,人们都面临每天的例子。如果您曾经尝试计划在家庭录像机的时间设置,并在遥远的手册 在厌恶的房间,你扔了一块写技术(虽然显然不是一个很好的!)。太多多次技术文献是与不是一个大的技术,或产生足够的把握作家 技术专家缺乏写作能力。作为一个潜在的技术作家,你必须小心的是在你的专业技术领域(拧知识非常微妙的线),以及作为一个'好'作家(如 反对'坏'谁通常可以找到抢劫老太太,或甜的东西作家)。技术文件制作通常是两个不同的用户群体,即专家级用户,和天真的用户。作为一个 你的首要任务技术作家之一是挑选出最观众你正在写的,这使我熟练地为:了解你的foeAs旧clichÃÆ'Ã, ©去,每个人的评论家。尤其是这样 大多数的有理智的人的反应时,面对技术写作。正如在录像机上面的例子中强调,技术写作可以坚不可摧的最终用户。如果是这样的话,那是因为 谁写的文件,并没有查明其受众,写他们的水平。这似乎是一个显而易见的道理,说的,但其中一个常常被忽视,即在文件的用户创建的, 其实不一定是专家。显然,如果您正在创建一个特定的用户群,特别是先进的专业生产文件(一个很好的例子是计算机审计系统软件 管理员),那么您将需要撰写这是一个完全不同的方式,如果你是,例如建立一个技术为大众市场经验的电脑在家庭用户开发软件手册。其中 你的首要任务必须完成,甚至之前落笔,键盘的手指,是确定谁是你的文件,用户将和建设的特定目标组(S)为目标的文件。如果 你这个阶段的正确,也应避免您的文件被丢弃在房间的烦恼!规划perfectionOnce您已经确定了你的文件将要创建的目标市场,则需要 开始计划如何将举办文件。这一进程在很大程度上取决于什么文件正在制作,但你可以跟随拇指粗一些规则。首先,如果文件支持 特别是详细的产品(如计算机应用程序)得到它你肮脏的双手尽快可以。通过检查详细的产品可以制订一项打击计划,并开始撰写一 组织结构。虽然你正在探索详细的产品,以做初步的探索,在这个阶段,大量的笔记,可以节省您的时间,可绝对重要的,如果你正在努力 最后期限。即使在规划阶段,必须确保有一个布局的一致性,组织结构的文件。选择编号公约,段落样式,并为设计粗糙的想法 而现在,并将其保存的重要时刻later.Let草案的inBefore到创建的文件,草拟了每部分的第一个潜水头向前。这将允许重新安排,如果正在创建的文件没有 逻辑'流'没有认真考虑对项目的影响。许多人(尤其是更详细的产品)的技术文件是由无数了(在某些情况下几乎无数)迭代。这是 因为产品的变化,并随时间的变化,和技术的作者的主要职责之一是将这些变化的步伐,并确保他们都是有据可查的。良好的技术作者将 始终把他们的文件,通过以不可思议的是,在每个炼油草案的许多草稿,直到他们达到,使他们(和他们的雇主)认为该文件是及时,准确和立场 一个产品或处理它documents.The魔鬼的真实反映,在已确定detailAs是,技术写作名字,是因为它在本质上是技术性的。被技术部要准确, 和精密零件是被以不可思议的细节。即使您正在创建的文件为一个先进的,技术先进的用户群,您的文件必须集中在一个细节 过程,或者使用的产品。这可能是一个难以完成壮举,但如果你写信给你的听众。从来没有假设读者知道的任何产品或过程的记录,但在案件 先进/专家用户至少有常识承认这一事实,他们可能并不需要知道如何使用的设备,他们每天运作。当描述如何进行 特定的活动或任务,确定人员(人数每个阶段,如果这种过时的文件类型创建公约),并确保你所笔试自己动手,甚至准确性 好,在相同的技能水平,最终绳子user.Choose志愿者为jobAlthough就可以创建使用羊皮纸和血液技术文件的权利的工具,这不可取的。许多专家 应用软件存在,以帮助您创建强大的文件,和你的职责的一部分,技术作者,包括选择了合适的工具。在很大程度上这取决于文件的性质 正在生产的,其最终分配的性质。如果文件可以交付使用互联网,这当然是要考虑的途径。为此,使如Flash MX和使用的软件包 Dreamweaver中实现这一目标。综合在线帮助,您可能希望创建原始的HTML文件,或者选择一个,如制作软件或类似的专业包装。在印刷的情况为依据, 您需要选择一个软件包,功能强大,足以应付你会在it.Many经验的技术作家抛出即刻转向微软Word(因为它是无处不在5月商业和 )的私人环境。除非你的文件将是下150页,您知道如何创建模板,使宏,避免微软Word。由于任何技术的作者都会告诉你有讨厌的习惯,一切的 自己的,往往是一个不稳定的包工作。如果您正在创建大量的图形文件,您不妨考虑Quark公司的Xpress,或选择有可能在这一领域的行业领先,Adobe公司Framemaker。 无论您选择的软件,你必须确保你变得令人难以置信的是精通,无论是投资于培训,或在使用它每天日复一日!交流-这就是你的工资做!很多人 会告诉你,创建技术文件是乏味和重复。这些人,都是错误的,并可能低能儿了。虽然您可能会发现创建技术文件'的过程无聊'(如果你 你是在错误的工作!)事实并非如此。创建高质量的技术文件,是一个让人们充分的重要阶段,正确地使用技术。虽然没有用户将接近的文件中创建 同样的方法,因为一种新的方法,你可以最终帮助他们实现他们想要达到使用技术。无论怎样'沉闷'的过程中可能显示为,使用户能够实现其目标的 读您的文件应该给你一个繁忙的骄傲,而事实上,幸福。只要你还记得的积极效果,技术可以对人们的生活,当您创建您的文档,您可以沟通 更有效,你会更快乐,在交际过程。在整个生命周期中的文件,你应该设法联络,尽可能频繁地(如适用)的同事。让他们读你的 文件,听取他们的批评,并调整您的文件(如果你不能说你的角落!)。一个技术作者支付的沟通,确保您做的,为什么你永远不会忘记的沟通,以及 其中,在文件themselves.Common错误,以避免makingWhen创建技术文件有一个致命的缺陷可以使数。虽然并非详尽无遗,本节更详细一些 常见的错误,在新的作者提出的希望你会避免他们过于:作为虽然技术文件应明确光顾- ,永远不应该光顾。您还没有创建文件 予以由低能儿,但消费者和客户。你应该总是以书面形式向听众技能水平,但不管是什么人的技术水平上,他们不是低能儿。即使孩子生气时,得到 光顾,不要与别人谁是你的薪水支付,儿童或幽默otherwise.Overuse的错误-人们不读技术文件,受理,他们阅读了他们成功的希望 完成一个过程,或提取信息。除非是相关的最终用户,尽可能避免幽默。如果你正在写一本书,罚款和好。如果你正在写一本手册,避免类似的幽默 鼠疫,随着越来越多的用户往往会错过笑话,只是最终厌恶的光顾白痴的说在起草阶段documentation.Inconsistency -即使,你应该确保所有的元素 在您的文档中使用的是一致的。这同样适用的'音作为它的布局文件'。确保使用一致的感觉(第一人等),以及页面布局,分页元素, 页眉和页脚,以及所有其他文字elements.Proof宣读创造的技术文件的结束- ,你可能会生病的忽视。不要紧。什么要紧的是什么叶子 你的办公室或家里,是准确的。为此,在所有的证据看它的汇票,并在其分布证明再读一遍,并不厌其烦的文件。仅仅依赖拼写检查(他们没有工作) 如果你能避免它,完全依赖自己的判断。让您的文档阅读许多双眼睛尽可能在分配前,毕竟,他们可以当场一件事你一直失踪 在整个创作process.Conclusion /无耻的自我promotionTechnical书面不管是不是你所想,一件容易的事。它需要的专业知识,耐心和技巧,是非常奇怪的混合物。就像 任何其他的工作,你可以学习如何做到这一点,但即使这学费不一定让你有任何好的。是一个很好的技术作家,你必须肛门的创造性,但集中交流,并灵活 专家。这,你也许可以想像,没有简单的任务。虽然你可能认为创建技术文件很容易,创造准确,一致和及时的文件到高的商业标准是 高度挑战性的角色。无论您的预算,从长远来看,将提供重要的投资回报率,如果你聘请的专家。毕竟,他们将能够做的天,你的眼泪你的头发,我们试图 在几周内完成,如果没有months.About年麦克的坎普已被列为自由就业的IT记者AuthorOver(出版物的工作,如登记册,Namesfacesplaces,关注安全和 PacketStorm的),撰稿人,电子游戏设计,安全审计,网页设计师,平面设计师和IT培训师。他曾在一个自由和两个小(如两男一狗常任理事国席位的品种) 在整个英国和欧洲公司的跨国机构。当不工作的各种文章,书籍,手册,并为客户提供各类其他副本,迈克通常可以找到的各种劳动 未发表的小说。他也有过独立制作公司制作的短短几个剧本,目前正在几个功能长度scripts.Mike愉快的工作生活大多在不堪
文章来源: Messaggiamo.Com
Related:
» Credit Secrets Bible
» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
网管得到HTML代码
加上这条到你的网站!
网站管理员提交你的文章
无须登记!填写好的表格和你的文章是在 Messaggiamo.Com 目录!
版权 2006-2011 Messaggiamo.Com -
网站地图 -
Privacy -
网站管理员提交你的文章,以 Messaggiamo.Com 目录 [0.01]