3个无痛的文档编写技巧

编写文档并不是最令人兴奋的工作 工程师可以着手。通常很无聊,很费时间, 还有更多有趣的事情可以做。有时让我惊讶 如果福建省体彩网不良项目甚至全部记录在案,则将它们记录在案。 文档旨在帮助保留重要的概念和信息 关于福建省体彩网周期。此信息可用于快速掌握 在产品上,做出有关更新和更改的决定,甚至证明 按照正确的程序来创建产品。在今天的帖子中,我们是 将研究福建省体彩网文档的一些技巧,这些技巧可以减少 福建省体彩网人员的痛苦因素,并提高了文档质量。

技巧1 –福建省体彩网时编写文档

许多文档(包括代码)的问题 注释),就是说明文档是在福建省体彩网完成后完成的。 由于交付方面的限制,工程师通常很着急,因此他们专注于 首先让事情起作用,然后再记录。问题是 很有可能永远不会编写文档,如果没有 是,福建省体彩网人员可能会在数周或数月后编写它,这意味着他们已经 忘记了所做的设计决策。结果文档是 通常总比没有好,但缺乏关键步骤或思考过程 这样一来,您就可以轻松地从福建省体彩网人员停下来的地方接机。

我发现最好的文档和最快的方法 福建省体彩网它,就是随您记录。例如,当我写 说明如何设置和运行测试的文档,我没有进行设置, 然后返回并尝试记住我执行的所有步骤。我从字面上创建 文档,每一步都要写下我的工作,更重要的是,为什么 做了我所做的。现在,当我走错了路而不得不回去调整时, 包含一些有关如何恢复系统的评论的绝好机会 还是要避免什么错误。

我还发现,通过随时创建文档, 我可以使用文档概述我将要做的事情,这将对您有所帮助 指导我的努力。我一直发现,花时间思考一下 我要做的是收集我的想法,似乎使我的工作效率更高。这个 比尝试“即时”执行操作要好得多。

提示2 –图片价值1,000字

对于我来说,这真是太神奇了 文档工程师创建的视频,丰富的图像和照片几乎 完全由文字驱动。我无法告诉您我多久会碰到一次文档 几乎没有任何图片。我最近在做一个 工程师向我发送了一个建立工具链的程序的项目, 部署生产代码。整个文档只有两页,而不仅仅是 难以遵循,但缺少步骤,没有图片或图表!的 工程师甚至假设读者会知道如何进行福建省体彩网 登上一个没有接线图的传感器!

虽然基于文本的版本可以用来重复 原始程序,遵循它的任何人都必须找到几个外部程序, 查看原理图并进行几次信念跨越,以便成功 完成它。一个原本需要一个小时的过程最终需要大约 四个小时。如果您遵循的第一个技巧是编写您的 随手编写文档,对过程中的重要步骤进行屏幕截图 或使用智能手机拍照仅需约30秒。结果 可以是更清晰的文档,可以节省用户(可能是 未来的你)很伤心。

提示#3 –让同事查看文档

我们今天讨论的最后一个技巧,应该 不容忽视,是让一位同事审阅您的文档时 您已经完成了。作为工程师,我们经常假设 来了之后,我们将以与我们现在或某些人相同的方式思考 信息花絮很明显。将您的文档交给同事 审查将有助于确保所有必需的信息都包含在 文档,以便以后有人来时,他们将能够理解 过程以及复制或维护系统。

同事可以充当一个很好的顾问,以确保 一切都是必需的。例如,我提到我有一个程序 没有提供任何图像给我。当我查看该程序时,我 能够指出应添加到的屏幕快照,图表和图像 该文档可以使某人更容易理解 程序是以及如何复制它。没有事先了解 程序并被迫重复进行,有助于提供关键反馈 这导致了一个不容易复制的完善程序。

结论

这些简单的文档编制步骤似乎很明显,但是我 知道事实,有很多工程师不遵循这些简单的原则 提示。我遇到了许多稀疏或未记录的项目 所有。对于福建省体彩网人员来说似乎很明显,使用代码需要做什么 基地,设置一个实验或其他。事实是,通常不是 很明显,一年后再来的同一个福建省体彩网人员经常会找到它 花时间让他们弄清楚一年前的想法。

发表评论

您的电子邮件地址不会被公开。 必需的地方已做标记 *

该网站使用Akismet减少垃圾邮件。 了解如何处理您的评论数据.