文档小小书 XXshu

物联网和技术文档

物联网市场目前正在迅速发展，每天有数百万个设备在线。在未来的几年中，我们将谈论数十亿个这样的设备。而且，由于没有充分的理由让物联网以这种疯狂的速度停止发展，因此最终我们将获得数千亿美元。这在所有电子设备中占有很大份额。并且，当然，技术文档应该在用户那里。技术作家最感兴趣的问题是：技术写作将如何变化？是否必须适应新环境？这是我们认为在过渡时期将要发生的事情。技术作家将更接近开发过程。使文档团队参与开发过程将使他们对工具的工作原理有更深入的了解。如果您知道其工作原理，则可以向其他人解释。尽管似乎当前的现实将这一情况推向了新的高度，但技术作家经常需要与就业领域相关的附加资格这一事实已是老新闻。由于物联网与可用性有关，因此冗长而复杂的用户指南将不再起作用。因此，帮助信息需要及时并少量地提供给用户。这就解释了UX作家的职业机会的增加。这种职业仍在弄清楚它想要成为什么样的人。雇主仍然不确定公司中的UX编写者是否需要扮演单独的角色，或者已经在职的人员可以承担这些责任。…

技术文档中的普通语言基础

技术写作或技术交流是关于向普通受众传递技术信息。在技术文档中使用通俗易懂的语言可以使文章清晰，简洁并且对读者有所帮助。通俗易懂的语言写作可以帮助目标受众轻松理解信息，避免误解并节省时间，因为它可以使工作第一次完成。定义简单的语言悉尼大学前现代英语语言副教授罗伯特·伊格森（Robert Eagleson）教授将通俗语言描述如下：朴素的语言是清晰，直接的表达方式，仅使用必要的单词；这种语言避免了晦涩难懂，夸张的词汇和复杂的句子结构；这不是在谈论婴儿，也不是英语的简化版。普通英语的作家让他们的听众专注于信息，而不是被复杂的语言所分散；他们确保听众容易理解消息。通俗易懂的语言是在使目标受众首次阅读时可以理解并采取行动。法律写作是技术写作的一种。它的显着特征包括语法过于复杂和过于形式化的趋势。比较以下示例，以了解使用简单语言编写的思想。前两段包含对读者来说不必要的多余信息，只有最后一段暗示了消息的目的。此外，整封信以过分正式的方式写着，句子冗长，不常见的单词和陈词滥调，难以阅读。让我们看看简单的语言是否可以改善本文。…

概念-伟大的工具

迄今为止我使用过的最好的工具我很少写这样的东西，但是对于概念来说，这让我印象深刻，我不禁要分享，但是，一旦我分享了，它就需要介绍那些出色的功能和新方法来管理我的项目并记录我的笔记。虽然，它仍然有一些缺陷，但是对我来说已经很完美了。什么是概念概念官方描述是文档，Wiki，任务-团队的最小化和统一工作区简单的一句话，但这意味着它将取代您的许多其他工具，例如Evernote，Quip，Trello等。这些工具也很棒，但是这个概念只是创建了一种不同的方式来编辑内容。是什么感觉我的朋友将“概念”描述为：就像Minecraft的文档一样他之所以这么说，是因为每一行内容，就像Minecraft中的代码块一样，您都可以四处移动。设置自己的模板，创建自己的工作流程。而且，如果您稍稍后退，您会在您面前看到整个图片，真是太神奇了。我第一次注意到Notion出现在Producthunt上，但是我并没有一见钟情，因为如果我不彻底尝试的话，我可能不会知道我会喜欢的所有功能。…

作家区：技术作家的秘诀

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

如何创建程序手册：终极技巧和工具

无论您从事的行业和专业领域如何，编写SOP指南始终是第一要务。在许多负责记录标准操作程序（SOP）的生产线经理中通常会提出的常见问题中，通常会出现诸如“创建程序手册或指南时应遵循的技巧以及使用哪个程序”之类的内容。以下是有关创建程序手册的一些重要信息。一旦掌握了这些信息，您就可以轻而易举地制作出帮助手册和指南。通常，普遍认为开发培训手册是一个相当无聊且耗时的过程。本文将揭穿这种信念，并建立一种全新的方式来编写SOP指南。像Pro一样创建程序手册如果您是企业家，部门负责人或负责维护和更新公司文档的人员，那么您很有可能需要一个可行的计划，以了解如何创建培训手册，操作指南，软件演练和员工入职指南。立即为它分配过多的精力。编写SOP指南的技巧和窍门记录政策和程序的原因有很多，但企业经常忽略它，而将其与无聊和被动的打字联系起来，而这种打字和打字以零创造力和想象力为前提。实际上，这是一个持续不断的过程，可以毫不费力地解决。本文将使您简化记录过程。在继续进行之前，让我们先弄清楚成功指南的原因。显示不告诉图像说出音量。对于任何作家来说，这句话都应该是一个经验法则，因为告诉他人和展示参与感。统计数据表明，视觉处理在大脑中的速度比文本处理速度快了60,000倍。…

六个非常规写作思想

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

金发姑娘知识区

有一天，这个家伙陷入了一个非常棘手的问题。他没有呆在窗外呆呆地凝视着几个小时试图找出答案，而是决定去当地的咖啡馆喝点咖啡因和一些灵感。他看到几个朋友坐在窗边，决定加入他们。他分享了自己的问题，并且尽管对话开始顺利，但对话慢慢转移到其他主题，而他仍未接近答案。但是，他现在对量子计算，赢得棉花糖饮食比赛的最佳方法以及布鲁克林日益高档化的知识更加了解。然后，他走向大学与一位教授朋友见面，他被称为“维基百科琼斯”。在他提出问题后，她亮了起来，说她对这个话题一窍不通。但是，在经过数小时的共享话题的起源，历史和具体细节之后，他仍然没有一个明确的答案，只是很多事实和数据。他意识到那时候他要去看医生迟到了。由于问题仍然困扰着他，他在检查结束时ly恼地问医生问题。经过几次简短的交流以澄清问题并了解他为解决该问题所做的尝试后，医生能够提供清晰，清晰和简洁的答案。这是Goldilocks原则，答案是正确的。解决问题的内容的原子单位不太短也不太长。同样重要的是，获得正确答案的道路是正确的。当我们面临一个困难的问题时，我们所有人都将面临这场斗争。对于技术问题尤其如此。我们陷入一些错误，或者想出实现或尝试理解一些旧代码的正确方法。如果我们只是一个线索或指导，或者只是有人要问，我们可以继续我们的工作。…

Elon Musk的写作建议

来源：http：//www.businessinsider.com 为了提高特斯拉的盈利能力，埃隆·马斯克（Elon Musk）向员工发送了电子邮件，他在其中描述了公司的目标，生产率建议等。这是他的工作效率提示： –过多的会议是大公司的麻烦，随着时间的流逝，情况几乎总是越来越糟。请参加所有大型会议，除非您确定它们正在为整个听众提供价值，在这种情况下，请尽量缩短会议时间。 –除非您正在处理非常紧急的事情，否则也不要参加频繁的会议。一旦紧急事件解决，会议频率应迅速下降。 –显然您没有增加价值时，退出会议或挂断电话。离开并不无礼，让某人留下并浪费时间是无礼的。 –沟通应该通过完成任务所需的最短路径进行，而不是通过“命令链”进行。任何试图执行命令通信链的经理都将很快发现自己在其他地方工作。 –问题的主要根源是部门之间的沟通不畅。解决此问题的方法是允许所有级别之间的信息自由流动。如果为了在部门之间完成某项工作，个人供稿人必须与他们的经理对话，后者与董事对话，与VP对话，再与另一VP对话，与VP对话，然后与经理对话。，与实际工作的人交谈，那么超级愚蠢的事情就会发生。人们直接交谈并做出正确的事情一定可以。 –通常，始终选择常识作为指导。…

完成技术写作项目后要问的15个问题

©Ugur Akinci 这个特定项目如何适应您的总体文件和收入目标？项目按时交付了吗？你赚了足够的钱吗？如果没有，您将如何改善情况？初始时间估算是否现实？您将如何改善时间估算？文档计划是如何成立的？哪些部分被证明是不现实的？文档计划的书写方式是否应该不同？哪些资源证明不足？时间？钱？有空作家吗？旅行津贴？训练？审查周期处理得好吗？…

2技术文档同行评审的黄金原则

©Ugur Akinci 在职业作家的职业生涯中，有时会被要求对他人或您自己的作品进行“同行评议”（是的，如今是复合“动词”）。这可能在小组会议（或电话会议/网络研讨会）中发生，可能会邀请您提供有关如何改进某些副本或文档的意见。在这样的情况下，重要的是要知道如何积极或富有成效，因为这样的会议可能会很快变得“个人化”和破坏性。这里有2项黄金原则，可用来学习并为此类审核流程做出积极贡献。不仅您的下一张薪水支票，而且您作为作家的整个职业实际上都可以依靠它。黄金原则1：从您的反馈中消除“您”。经常谈论自己以及您的印象，感受等。但还是尝试一下。当谈论自己时，您并不是在直接批评任何人。这样一来，就很难无视您在说什么。例如，避免这样说：“您写ABC是不正确的。” 请尝试以下操作：“我觉得ABC可能不正确。” 黄金原则2：消除普遍性，并以特定性代替。…