文档 – 第3页小小书 XXshu

通过“文档创建”简化您的工作流程并提高生产率

我们很高兴宣布旨在简化您的工作流程的新移动功能：PDF文档创建者，拖放电子邮件附件以及我们与iOS Messages的集成。 PDF文件扫描仪我们新的移动扫描功能使数字化物理文件变得容易。该工具不仅限于将纸张转换为PDF，还可以将下次会议中白板上的内容直接记录到手机上。只需输入您的转到共享文件夹，选择“新建”>“创建新文档”，然后将其移开即可。我们的应用程序会自动平整那些不可避免的角度，使新文档清晰易读。与您的团队轻松共享新的PDF。我们如何使用文档。视频播放器 00:00 00:05 如何通过“文档创建”更智能地记录文档。视频播放器 00:00 00:22 消息应用程序集成通过链接共享内容可提高审核报告，通知，到期设置等的效率；…

如何在技术写作中使用“牛津逗号”

牛津逗号也称为串行逗号，系列逗号或哈佛逗号。有趣的是，为什么要用这个逗号命名，但是不幸的是，关于牛津逗号历史的信息并不多。第一次提到基于牛津逗号的规则是1912年F. Howard Collins撰写的“作者和打印机字典”和1918年William Strunk撰写的“样式元素”。，以及牛津大学出版社的编辑。牛津逗号已经够老了，但是关于其用法的争论仍然有意义。怎么了？牛津逗号是紧接在连词之前的逗号，例如项目列表中的“和”或“或”。它用于分隔列表中的项目，以避免产生误解。例如，您应该使用牛津逗号吗？好吧，牛津逗号是可选的，一些指南说您必须使用它，而另一些指南说它不是必须的。说到技术写作，使用逗号是必不可少的，因为在这个领域中的歧义是不可接受的，并且可能会导致成本高昂和危险。最后一个逗号告诉用户最后两个项目是不同的，而不是两个的集合。因此，我建议您使用牛津逗号，因为技术文章的主要目的是创建清晰的手册。当然，您可以不同意并说句子的意思很清楚，而无需使用其他逗号，但是请使用所有可能帮助最终用户有效实施手册的方法。…

编年史者，图书馆员和内部学习者

那么，我在做什么？好问题。编年史/馆员对于Hitesh单手承担的庞大任务，有话要说。他的关注有两个方面： –首先，他认为他们（主持人）需要更好地展示自己和他们所做的工作。 –其次，他更感兴趣的是，他希望创建文档以共享知识，同时确保保留培训中的想法或知识以及扩展最佳实践。我觉得，这是一个想法的核心，希特什（Hitesh）试图做些事情。如果我们承担了Hitesh试图扮演的角色并将其正式化怎么办？想想团队可以让一个人嵌入其中的关键任务是成为故事，关注点和实践的记录者和分享者的团队。我想到的是一个常驻的“吟游诗人”，他的关键角色是文档，并且能够调解与其故事数据库的互动，增加更大的组织存储和知识存储，并最终帮助人们检索相关信息适用于其自身情况的信息。简而言之，是编年史家和图书馆员的混合体。现在，在基层或最后一英里的办公室，人们所关注的问题注定是眼前的问题和挑战，要在几个层次上逐步提高关注点，这些关注点是关于平衡油田需求以及高层管理人员和管理人员的关注。以此类推。现在，想象一下编年史家/图书馆员在整个组织的不同层面所扮演的角色。几乎感觉就像是一种从内到外重新思考该工具包的方式，以一种共同协作的方式“动态编写”知识的活泼资料库的方式，对代表层次结构各个阶段的每个“作者”给予同等的重视。在这些人扮演作者和调解人的双重角色之后，您将拥有一小撮人，他们了解内容和上下文，可帮助您访问和理解内容。因此，将这一思想向前推进，就永远不会有一个“完成”的工具包可以分发，如果使用了正确的ICT平台和工具，它就成为组织或一个组织在项目上进行协作的知识管理工具。当我心中的极客很想深入研究技术规格，设计和交互原理等时，我就在这里停下来，让这个想法有所启发。…

干杯! 一年以上写作

是的，我已经积极写作了一年多。我开始写作是因为我想记录自己的经历，所学到的知识，以便于参考，当然也可以与其他人分享。我的最终目标是写自己喜欢的读书方式，这很容易，我想写，我想读书。对我来说，这是下一个挑战性的阶段，我知道它将帮助我的写作变得更好，将帮助我更好地组织思想，将帮助我创建我认为缺少或强调不足的信息。所以首先我主要为自己写作。是的，获利从未列入名单。自从去年9月开始以来，我已经写了大约50篇文章，今年年初，我的目标是每月至少写2篇文章，我知道我可以使用它，而不论我一个月内有多忙能够抽出时间写作，我已经达到了这个目标，而且大部分时间都超过了这个目标，因为我认为写作还不够，最终目标是分享它，所以我责成自己分享自己在Twitter上写的东西，Facebook和LinkedIn（如果适用），只希望一次即可吸引人们阅读和反馈。老实说，分享有时是写作者的难点，因为您认为自己的写作不够好，或者想知道为什么要与人分享这种经历或人生的一部分—嘿，我我现在是一位女权主义者-必须成为我最脆弱的职位之一，并采取了许多个人强制措施来单击“发布”。另外，我决定不将Google Analytics（分析）附加到我的网站上，我不想打扰检查多少视图和访问次数，因为我真的只是想让自己能够继续写作-在此阶段监视视图会分散注意力。我现在比较自在，我最近添加了Google Analytics（分析）的有趣统计信息。我的Nysc经历一年和Camp的视野最高。我还没有写文章的地方，也没有写很多我想写的东西，即使这篇文章本来应该早些写的，但它决定保留在我的草案中。当我写信时，我仰望的人很多，现在几乎没有人记得我的英雄阿德伯勒（Adeboro）自从我以为自己可以写作之前就一直在写作，她的写作风格真实地反映了她的性格，她的坚定不移确实让我觉得我还没有开始，希望她永远不要停止写作。塞思·戈丁（Seth Godin），我几乎每天都会访问他的博客，他朴素的写作风格使我意识到我没有理由不写作。…

为什么工程师不写？

图片由思想目录在未飞溅我相信每个工程师在他们的每一项工作中都有这一时刻：“为什么没有人写下为什么这样做……”而且，句子可以通过多种方式结束。我专注于第一部分。工程师实际上不喜欢写下来。我正在与CTO讨论文档。他欣然承认是的，比他想要的要少。然后他承认让我感到惊讶的事情：人们是不好的作家，他们做得不好。如果做得不好，就避免这样做。编程实际上是在编写。您有两个听众，一个是编译器，另一个是需要处理您的创作的其他人。在我们所有的适当教育中，我们专注于为编译器编写代码。是的，现在的重点是“干净的代码”，样式和使代码具有表现力。但是它始终是次要的-因为如果您的代码无法运行，则没人在乎是否可以读取它。我们被赋予了一个讨厌的计算机程序员的刻板印象，不善交际，沮丧，不能与除计算机之外的任何事物进行交互。他们生活在地下室中，在黑暗中，敲打键盘，独自工作，创造了令人惊讶的重要事物。独奏英雄。这是一个错误的刻板印象。别人相信我们这是有害的。…

迁移到新文档工具的提示

by ClickHelp —专业的帮助创作工具迁移到新工具对任何人来说都是痛苦的。即使在您的公司中实施了新的Messenger，也仍然存在过渡期。是的，由于发送消息是应用程序的主要功能，因此您仍然需要一些时间来习惯新的UI。当您是一名技术作家，手头上有许多文档项目时，要迁移到新工具听起来像一场噩梦。首先，让我们找出迁移到新的帮助创作工具的原因。然后，讨论可以简化此过程的步骤。效率低下是第一原因。不使用专门为技术写作目的而开发的工具将始终导致效率低下。另外，如果您已经在使用HAT，请注意工作流程/其他功能限制。一些文档工具可能不够灵活，因此，您会注意到在工作过程中必须实施多少个变通办法。另一个指标是创建技术文档时必须使用的第三方应用程序的数量。您是否正在使用单独的工具来收集统计信息，将输出文件转换为所需的格式？在那里，这是对时间和金钱的严重浪费，因此应考虑迁移。附带说明：只要迁移原因有效，就应尝试选择最佳的执行时间-可能是在新产品发布后的某个时候，尘埃落定。当然，对于每个帮助写作团队来说，合适工具的定义都会有所不同。…

技术写作的组成部分是什么？

（图片由Unsplash dot com上的Rawpixel提供）答案取决于您所指的技术写作的“ 组成部分 ”。我们可以通过两个向量来解决这个问题：技术写作过程的组成部分和技术写作产品的组成部分，它们当然是技术文档本身。（1）技术写作过程的组成部分（1a）首先是分配，因为除非有分配，否则几乎没有技术作家会开始写任何东西。您需要具有文档问题的客户或经理，您可以针对该问题提供文档以解决该问题。（1b）范围和听众是任何作业中两个最重要的方面。您是为谁（观众）写作的？您应该将什么包括在文档中（从范围中排除）？这是在触摸键盘之前需要清楚回答的两个问题。（1c）接下来是研究。您需要遍历现有的相关文档，尤其是如果您正在编写的是现有文档的新版本。您需要确定您的中小型企业（主题专家）是谁，并通过与他们进行面谈并使他们对任何问题保持接触来使他们参与其中。…

您的写作应该有多细？

©Ugur Akinci 您的写作应该有多详细？这个常见问题有时也称为“粒度”问题。例如，考虑以下相同过程的替代描述：描述1（不是那么详细）： 1.在IE11中打开First.html 。说明2（非常详细）： 1.在浏览器的URL窗口中，输入以下URL，然后按Return键：http：//windows.microsoft.com/en-us/internet-explorer/products/ie/home 2.将Internet Explorer 11（IE11）下载并安装到您的计算机上。 3.启动IE11。 4.选择“ 文件”>“打开”以浏览并在Windows资源管理器11中找到文件First.html 。 5.选择并在IE11中打开文件。…

技术写作技巧：80/20规则

by ClickHelp —最佳帮助创作工具有时，您只是打开一个用户手册就知道它是不好的。它看上去并不马虎，它具有很多内容，可以从各行中看到文档团队的辛勤工作。而且，它仍然很糟糕。这怎么发生的？我的朋友们，这是一个文档团队因不遵守全能80/20规则而沦为受害者的例子。在本文中，我们将教您如何使用它并创建高质量的用户指南。可能很好的用户手册我猜我们所有人都偶然发现了这样的用户指南：有很多主题，数百篇，每个功能似乎都被提及。我们去哇！看起来非常有用！”。然后，失望降临了-大多数主题看起来非常简短而肤浅，大多数情况下，它们只是描述某些功能而没有提供任何提示或用例。基本上，它看起来更像是字典，而不是产品文档。我们可以猜想，负责本用户指南的技术作家做了很多工作，并确实对项目进行了一些思考。他们的结构正确，涵盖了几乎所有功能，我们看到了正确的语法，正确的屏幕截图……但是，这几乎没有用。怎么会？…

为什么这么多企业文档如此糟糕？

我花了很大一部分专业工作时间阅读技术文档。也许“通读”并不是描述它的正确方法。在这一点上，它更像是快速扫描菜单，常见问题解答和段落标题，以获取在哪里可以找到所需确切信息的线索。除了某些例外情况，无论是我只是想快速确认正确的命令行语法，还是想让自己了解一种全新技术，这种情况都很常见。基于Web的技术文档：性能不佳的艺术现在，我对那些提供详细语法指南和手册页的人没有任何抱怨-他们为什么要重新格式化整个文档以突出一些我可能有一天会去寻找的晦涩细节？但是，当我试图向自己介绍一个复杂的软件包时-要弄清其目的和主要用例-那么我有理由期望有一个相对可预测且舒适的实现目标的途径。取而代之的是，我经常遇到一个项目主页，其中包含指向多个目标的链接，这些目标的名称为“入门”，“如何使用…？”，“文档”，并深深地埋在几个菜单层的“快速入门指南”下。通常，我发送到的页面不完整，显然是改变主意和预算超支的受害者。其他将涵盖该软件的过时版本，这些过时版本可能具有与最新版本明显不同的功能集。更糟糕的是：这些功能实际上可能仍然存在，但是从那时到现在，它们已经更改了名称甚至图标。即使我们忽略了写作的质量（控制起来可能非常困难且成本高昂）和单个文档的可理解性，似乎经常还会出现重大的版本控制和项目管理问题。我通常可以猜测发生了什么：一些客户抱怨说他们无法弄清楚如何使用该软件，因此管理层（无法自行正确评估文档的当前状态）命令从头开始创建一套完整的新软件。。该项目开始了，但是大约一半的时间里，主要贡献者要么离开了公司，要么因其他截止日期和需求而分心。直到有更多的客户抱怨他们也无法弄清楚如何使用该软件，才坐下来。冲洗。重复。…