技术写作 – 第2页小小书 XXshu

ClickHelp带来的商机

您对帮助创作工具有什么期望？让我们尝试猜测：直观的界面，稳定性，功能灵活性，多种受支持的格式，优质的客户服务，合理的价格。我们可能错过了几件事，但您明白了。但是，如果将技术写作解决方案设计成不仅能满足所有这些要求，该怎么办？不要误会我们的意思，上面提到的列表非常好，请接受这样的想法，即帮助创作工具实际上可以成为推动您的业务前进的力量。这有可能吗？实际上，使用我们开发的帮助创作解决方案– ClickHelp很有可能。进一步阅读以了解有关使用我们的工具可以为您的企业带来的好处的更多信息。时间等于金钱当公司决定将文档项目转移到新工具时，弄清楚将损失多少时间是至关重要的。您会看到，启动此迁移过程可能需要大量资源。由于大量可用的导入格式，ClickHelp将能够为您节省大量时间和精力。导入过程本身既简单又直观。此外，该工具非常擅长处理文档格式。将用户手册导入ClickHelp文档门户时，可以确保结果符合您的期望。该帮助创作工具能够理解您的原始格式，并调整结果文件在新文档门户上的显示方式。业务流动性…

作家区：技术作家的秘诀

by ClickHelp —最佳的技术写作工具告诉我们以下内容是否熟悉。您必须为产品创建知识库。您仔细阅读了说明，进行了研究，并澄清了与开发团队之间的知识差距。但是，是时候坐下来写内容了，。您不能输入一个单词。当空白文档凝视着您时，您会感到慌张和绝望。那是作家的障碍。等待一秒钟，您可能在想！技术作家会遭受创作障碍吗？毕竟，创建知识库不需要创新的思维，那么他们如何经历这种斗争？没错，技术写作除了小说写作外还需要其他技能，但这并不意味着作家没有受到伤害。许多不同的因素都可能导致作者受阻。他们是：压力 -它可能是由工作环境或项目的重要性引起的；…

技术和创意翻译是否总是天壤之别？

技术手册和营销手册似乎位于翻译领域的两端。一个是干燥的，首字母缩写词，需要进行主题研究；另一个是动态的，可能是双关语，需要创造性的方法。一个重视准确性和清晰度，而另一个则重视与目标受众的情感共鸣。这些重要的差异正是翻译人员通常专门研究特定领域（例如文学，技术或法律文本）的原因。但是，翻译人员有时确实会处理其专业领域之外的内容。通常，这是因为他们所面对的内容不容易适应既定类别。例如，白皮书是营销文件，在某些时候深入研究了严格的技术说明，同时使用有力的说服力的语言来吸引和激发尽可能多的其他受众。那么，技术和创意翻译之间共有哪些共享技能，可以使他们在值班时变得灵活起来？ 1.确定目标受众译者既是所处理文字的消费者又是其生产者。他们阅读并消化以一种针对特定受众的语言编写的文本，然后以另一种语言为完全不同的受众复制文本。胜任的翻译人员必须善于识别需要进行哪些更改才能使文本更适合其受众。优秀的翻译人员在阅读原始文本时会反思他们作为站外听众成员的经验，并以此为目标语言的写作提供依据。当灵活地处理不同种类的内容时，这意味着翻译人员将快速识别新观众是谁，并且，如果该新观众不熟悉，则提出正确的问题以填补其知识上的空白。 2.做作业技术和语言的共同点是两者都在不断发展。当技术翻译处理具有创新性的产品的用户指南或其他文档以及为解释它们而创造的新术语时，他们会被提醒这一事实。…

我的技术写作哲学

我之前在Twitter上说过，我喜欢采访，因为这使我有机会谈论自己的技术写作理念以及如何实施它。好朋友提醒我，谈论一个人的哲学和实现的理想方式是获得可观的小时工资。那是真的！我切断了我觉得是剥削性的采访。问题在于，大多数业务和开发人员并不完全理解普通技术作家的工作，更不用说技术文档架构师，他们在技术演讲方面有大量副业。如果我想获得一个适合我的职位，我必须向他们解释为什么他们需要它。我不必太担心自己能建立自己的事业，因为它太笼统了，以至于我的实施细节也很难在没有扎实构建学科的基础上实施。让人们品尝我的思想只会激发他们的食欲。特拉维夫市场上惊人的石榴核心原则没有人愿意阅读文档。技术是达到目的的手段，而不是目的本身。用户对技术的体验与创作者不同。回答问题比提供全面的信息更有价值。当我这样说时似乎很直率，对吗？但是，这些原则中的每一项都是我从艰难的道路中学到的，自己为自己制定，并在行动中观察。没有人教过我。许多人为我的思想做出了贡献，但在这里，重要的是我的综合。…

建立更好的技术编辑和质量检查周期

当我没有听到关于文档的技术编辑和审阅以及整个质量检查周期的投诉时，这种情况很少见。不幸的是，因为构建了可支持和可复制的文档质量检查流程为文档构建技术编辑和质量检查周期时，请牢记以下几点注意事项：建立标准和风格技术编辑是关于标准的-您甚至需要非正式地制定一些文档编写标准和样式。编写样式指南可能是一项重大承诺。设定文件审查的期望我总是建议组织为技术编辑和审查设定期望。在今天的日程安排很紧的情况下，我的建议是一个迭代的审查周期。只需在每个审核通过末尾给您的审核员对文档的期望即可。管理和使用文档模板 Microsoft Word文档既是福音，也可能是生产力的拖累。我建议您和您的团队都管理和使用所有文档的文档模板。管理模板包括记录作者应使用的样式；响应任何模板问题，并促进正确使用模板。使用文档版本控制和工作流程使用Microsoft…

技术写作与创造力

技术写作可以富有创造力吗？对于大多数人来说，“写作”一词意味着富有创造力。但是“技术写作”的组合可能会使人们感到困惑。因此，让我们澄清一下。创意写作那么什么是创意写作？ “ 创意写作是超出正常专业，新闻，学术或技术文学形式范围的任何作品，通常通过强调叙事手法，性格发展和文学比喻的使用或具有各种诗歌和文学传统来确定。诗学。由于定义的松散性，即使故事故事属于新闻业，也可能将诸如故事故事之类的写作视为创造性写作，因为故事的内容专门针对叙事和角色发展。虚构作品和非虚构作品均属于此类，包括小说，传记，短篇小说和诗歌等形式。在学术环境中，创造性写作通常分为小说和诗歌两类，着重以原始风格写作，而不是模仿犯罪或恐怖等早已存在的体裁。屏幕写作，舞台剧本写作和剧本写作通常是分开教授的，但也属于创意写作范畴。” 〜维基百科创意写作包括以下类型：诗歌剧本影视剧本小说（小说，中篇小说和短篇小说）…

六个非常规写作思想

除此之外，还有常规的文档页面-示例，教程，说明控件支持的数据源，如何对控件数据进行过滤和分组的文章等。小时的问题是这些文章是否应提及所有这些内容。我之前提到的2000多种属性，方法和事件。这个问题的一个答案是“是”，因为“如果您不全部提及它们，那么用户还将如何了解它们？”从这一观点出发，您正在将文档转变为仅显示一部分API和留给读者去寻找剩余的东西。我不同意。鉴于文档中已经包含“ API参考”部分，读者可以自由浏览这堆内容，并为每个可用的公共项目找到描述。单独的帮助文章则是完全不同的实体。作为作者，您不应以提及现有API的每一点为目标。技术作家的工作比遍历Visual Studio的“属性网格”中的属性A到Z更重要。这让我想起了一个原始人，他使用mo吟声，吟声和壁画在一个部落面前分享他最近的发现-火热，石头折断，猛stick象很强。相反，有一个故事。您的工作是引导人们开发复杂的产品-为他们画一条学习曲线。您的目标不是要提及每个现有成员，而是要说明某个功能的主要用例是什么，可以直接使用哪些功能。然后添加更多特定的案例，将最高级的特定场景留在边缘，然后将其转移到专用示例和操作方法上。一言以蔽之，过滤信息并将其分解成几部分，然后根据这些内容构建叙述。结构忘记什么是“功能” 多年来，我们一直在编写基于功能的文档。…

我的职业道路：严格的技术写作

我如何从公司技术写作变成自由职业者内容写作第1部分在过去的五年中，我一直在IT行业担任作家。技术写作，市场营销，社交媒体营销，公共关系—我已经为乌克兰最大，最古老的软件开发公司之一工作。我感谢这些经历中的每一项，因为它们为我提供了有助于我个人写作风格的独特技能和知识。现在，我是一名自由内容作家，我想在“我的职业道路”系列文章中分享我如何到达这里的故事：严格的技术写作，可爱的市场营销，有力的PR和解放的自由写作。第一个是关于我写技术的日子，所以抓些爆米花走吧。（顺便说一句，不久以后将有一篇关于 Informaze 的文章，介绍我在不同部门撰写的各种内容的特殊性，敬请期待！）科技写作那是2012年。我是一名5年级学生，即将开始写文凭并在语言学校做兼职。…

技术交流中的“技术”

吸引到技术交流领域的大多数人都爱上了文字。他们喜欢获得报酬以度过一天来制作完美句子的想法，并且希望知道人们会依赖这些句子而感到满意。但是，正如我之前在其他帖子中所说的，技术交流已不仅仅是写完美的散文，而且那些希望在这一领域取得成功的人必须意识到不断变化的形势，以便以有意义的方式做出贡献。更老练的观众随着智能手机，平板电脑和互联网等技术的双重产物，人们越来越多。用户体验等学科的发展也意味着产品的成功通常与产品的直观性有关。这意味着通常来说，软件手册或《入门指南》的典型读者将能够浏览产品而无需逐行引用文档。这并不意味着就不会发布没有某种文档的重要的硬件或软件，而是意味着这些入门类型的手册已成为其他类型的教学介质的第二代。对于API和其他面向开发人员和工程师等技术读者的专用工具，文档已变得最相关。进行这种“写作”所需的技能与编写传统手册或指南的技能相似但不相同。更重要的是，编写专门的文档需要具备专业知识，而不仅仅是写完美句子的能力。利益相关者从字面上讲另一种语言 Java，Python，PHP，Ruby，Perl。。。清单继续。仅在软件中，就有许多编码语言，开发人员在其中工作并遵循的流程的平台。尽管我从未在任何其他领域工作过，但我认为医疗作家，法律作家和各个行业的文档开发人员的情况都是一样的。…

蒋泰德：从技术作家到科幻明星

随着电影《降临》（Arrival）即将在中国影院上映，我们认为，聚焦故事背后的人，技术作家，科幻作家泰德·蒋（Ted Chiang）很有意思。这部电影由艾米·亚当斯（Amy Adams），杰里米·雷纳（Jeremy Renner）和森林·惠特克（Forest Whitaker）主演，根据他广受好评的中篇小说《你的人生故事》改编。科幻社区，并获得了许多著名的写作奖。在最近的一次采访中，蒋介石试图解释技术写作与创造性写作之间的区别：“技术写作与小说写作对我而言是根本不同；他们唯一的共同点是，它们利用了我大脑的造句部分。我不确定技术写作是否会对我的小说产生直接影响，但我认为最初吸引我从事技术写作的冲动也是我的小说的基础，也是一种清晰地解释一个想法的愿望。” 蒋介石（Cang）生于1967年，他年轻时就爱上了科幻小说，并在15岁时就开始向杂志提交故事。尽管如此，他到大学时仍未出版，而且遭到了拒绝。信件使他沮丧。 Chiang最终在西雅图担任Microsoft的技术作家，并在整个技术写作生涯中继续撰写故事。 1990年，科幻杂志Omni最终同意出版他的短篇小说“巴比伦之塔”，该小说将继续获得蒋介石的第一个星云奖，这是美国出版的年度最佳科幻小说和奇幻小说奖。蒋介石又用了8年的时间出版了他的第二本名作《你的故事》，讲述一位妇女被军队征召与一群外星人进行翻译和交流，而外星人的语言被证明是如此困难以致最终改变了方式她看到了她周围的世界。蒋介石花了四年时间研究语言学，以使故事更具说服力，从而证明了他对准确性的奉献精神。他的作品以其细致的细节和对科学概念及其对人类状况的影响的考虑而著称，这导致了深刻而有意义的故事，这些故事常常使歌迷质疑自己的存在。在2015年接受《加州周日杂志》采访时，蒋介石说：“他现在把一半的时间都花在技术写作上，他说他很喜欢，因为他喜欢解释事物，而另一半则致力于小说。”他拒绝了雨果奖，因为他觉得这个故事不值得。但是现在，将近50岁的蒋介石可能终于获得了他长期追求的人气。…