前五位的错误，公司方面的技术档案资料，使
我见过多次。其中最常见的，我已经看到，在工程公司的弱点，实际上，几乎普遍的故障，是缺乏适当的技术文件。有人会笑这看成一 小细节，但是，往往受到严重的影响。一个公司的整个未来能够制造或者丢失的基础上重视中这几年，我已经确定了五个方面的问题，我已经issue.Over金额 发现是特别常见，当涉及到编写的技术文档。我想与你们分享这些想法，在防止跌倒同paths.1人的希望。由于没有任何用户 manualsDon't笑。这似乎是一个相当基本的错误，荒谬的，甚至，但它是很常见。我遇到很多公司没有为他们提供的产品，或其手册用户手册 骨骼薄或几年过时。事实上，我估计有一半左右的小工程，我公司所遇到的属于这一类。 （当然，很少遇到这种问题，因为购买 现成的通用软件或消费电子产品。虽然当中的工程师，这是一个令人沮丧的故事。）我记得一位工程师告诉我，为什么他的公司没有提供其产品的用户手册。在 小声，他说：“这是因为我们没有写手册的任何款项。这不是一个赚钱的企业，所以我们的管理层不希望在此浪费时间。”一个愤怒的表达悄悄进入他的 脸，然后他俯身密切，说：“我们已经失去了许多客户，因为我们没有像样的文档。论是小钱，丢了西瓜！”这不只是顾客谁受害 手册不足或根本不存在。怎么样雇员本身？时会发生什么新的工程师在船上来了，得赶快学习？时会发生什么，或现有的工程师需要熟悉 自己更符合他们的产品线不熟悉的方面？用户文档，如果得到适当的书面，可以提供一个使提高速度温和的和有效的方式。没有它，他们将不得不依赖 更严重的其他的工程师，教育他们，浪费大家的时间有关。数周甚至数个月的宝贵的人力，可以在这个fashion.2浪费。由于没有适当的内部documentationIt的 不只是用户文档，公司没有达到。内部文件，往往是一个事故，以及作为公司争相推出的产品。在他们迫不及待地将产品推向市场，公司 经常让他们的内部设计文件下降的wayside.It绝望无助的程序员和工程师因臭名昭著的沟通技巧不佳，而文档的任务 他们很少享受。我已经遇到了许多软件公司，例如，其软件设计是一个棘手的烂摊子，因为它们的建筑文件，接口描述和缺乏代码的评论。 可悲的是，我已经看到了类似的问题，当涉及到机械设计，电子设计，制造程序？你的名字it.I这首谈过，他们公司已下了工程师，或已摇摇欲坠 在边缘。几乎无一例外，缺乏足够的文件已经在这种situations.I主要因素总是告诉我的老板和同事，“我要确保我的工作是该死的有据可查的。如果我 离开公司，或者如果我在一场车祸死了，因为我要确保这家公司可以进军没有我了。“这应该是维持背后详细的文件，以确保首要原因之一 该公司将不会被削弱任何人的absence.Unfortunately，很多员工采取相反的策略。他们故意节衣缩食的文件，认为这将确保他们的工作保障和 有时，这个工程。不过，聪明的雇主知道谁文件的工程师以及价值远远超过另一名工程师谁把他的卡接近他的背心更多。后者可能是必不可少的，在短期内， 但最终，他是一个长期liability.3。忘audienceThis问题往往发生在发展中国家的用户文档。程序员和工程师经常忘记，他们的手册将要读 人们谁是他们的产品，或谁没有相同的技术人才相对陌生。我记得有一个公司，特别是，对西海岸机控制器的公司。他们的“用户手册”是一 可怕的五花八门的缩略语规定真，不确定的条件和看似随意的想法，并在任何一个特定的顺序列出十几个程序。他们的用户文档等缺乏基本的细节如何启动 控制器，还是如何停止在紧急情况下，关键的细节，任何新手用户应该可以发现在manual.A有关的问题是没有使用恰当的语言。考虑案件中， 对许多读者的母语并非英语的说，当市场在欧洲或亚洲，产品或书面向外国出生的工厂工人装配的程序。在这种情况下，可能需要保持 语言相当简单。如果这是不可能的，也就是说，当讨论复杂的细节，要求大量的精密，经常可以补偿，加入一些恰当选择的图表，图表或照片。或者 方法可以有助于使复杂的文字有点容易absorb.4。没有适当graphicIt是不容否认的clichÃÆ'Ã， ©，但事实仍然- 1图片没有油漆千言万语。同样， 手册，使图像和图表会更容易理解比一个是完全由文字descriptions.Some认为这是幼稚和不必要的合理使用。我不，我的 经验表明，大多数用户拥有这些视觉欣赏指南。记住，不管多么复杂的读者，他们仍然是人类。即使是聪明的，否则细心的读者可以 偶然错过一些重要的细节，尤其是为time.5的压力。不是争取excellenceIt有趣，看看程序员和工程师们可以在追求卓越的工作，但许多方面 采取完全相反的做法当谈到文件。 “谁在乎字眼吗？”我听说很多工程师说。 “我们不写诗歌或剧本这里。要紧的是， 文件必须在技术上是准确的。“这是一个惊人短视的看法。技术精度确实重要，但它已经演示和风格。会听取的求职者几个工程师谁 显示了浴衣，拖鞋，或诉讼律师谁喜欢山谷女孩说话，，但不知怎么，这些相同的工程师，技术人员希望他们的同胞（或者更糟，客户！）的熔渣通过蜿蜒的网页， 文本措辞很差。即使问题作为基本的拼写，语法和校对，往往被视为单纯的烦恼，piddling细节值得只是粗略地看一眼的。（让我感到轻松，我也没有 在我所遇到的就业有何这种态度。我必须这样说，怕有人觉得我很了解的人，我与抱怨！不，我发现，我们都明白了卓越的价值， 为此我一直感激。但是，我离题了。）请记住：当为自己的同胞写的技术人员考虑到，应该承担，他们必须经常吸收的时间很少量的信息和大量的数额。何时 外行写的，应该使该文本温和，易于消化，尽可能，以免他们成为一个geekspeak海洋丢失。无论哪种方式，挤进优雅的风格问题上有一些额外的努力可以 做一个difference.I世界将不打算把什么是良好的写作技巧，因为这超出了本书的范围细节。我只想说，一个好的程序员或工程师应确保 他的作品是可读和组织良好的，而且流动顺利地从一个话题到another.I将是令人难以置信的兴奋，如果我从来没有见过一个粗制滥造手册，或者如果我从来没有听到另外一个故事 由于倒塌的公司不存在的文件。阿无望的幻想呢？大概。不过，我希望有一些技术人员在那里会读此消息，并说他们将采取它heart.About的AuthorV。贝尔巴拉斯科 拥有电机工程博士学位，并已行走了近十年的贸易。在此期间，他曾多次发现了良好的技术写作的重要性，以及可能出现的缺陷，从 忽视其value.Dr。贝拉斯科现为高级电气和软件蜂窝技术有限公司（http://www.immunospot.com，工程师http://www.elispot-analyzers.de），一个生物技术公司在克利夫兰，
文章来源: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
网管得到HTML代码
加上这条到你的网站！
网站管理员提交你的文章
无须登记！填写好的表格和你的文章是在 Messaggiamo.Com 目录！
