我被突然介绍了编写技术文档的过程。 分配任务后，我立即尝试在Google上查找该任务，这让我更加困惑。 我一直在想，“那么……我该写些什么？”。 希望这将有助于新手进入技术文档，以克服这些困惑并阐明所有相关方面。
我应该记住什么？
首先，通过简要讨论技术文档的绝对必要性，使基础知识变得简单：
- 了解目标受众的水平
在开始编写文档之前，您需要记住谁是您的目标受众。 这是任何书面文章的一般规则，但是，它在技术文档中起着至关重要的作用。
所使用的语气和所提供的信息都将根据预期的阅读者组而发生巨大变化。 它将以不同的方式对待开发人员和维护人员。
如果本文档供维护人员使用，则不能在产品背后提供太多有关代码的详细信息。 另一方面，如果这是给开发人员的，则他们需要确切地了解下面的编程是怎么回事。 每次新开发人员取代旧开发人员就座时，他或她都会通读本文档以了解整个体系结构和工作流程。
2.点层次
您提出观点的方式应该保持连贯性。 这些要点或标题的顺序必须使整个阅读过程对所有读者来说都是顺畅的。 因此，在开始编写文档之前，请先在备用纸上写下需要注意的地方。 然后将它们编号，找出其中的正确层次。 这将使您易于编写，并使观众易于理解书面材料。
3.语言简单
由于在世界各地都教授和实践英语，因此任何公司都希望使用英语的技术文档。 但是，如果您的公司采用其他路线，则可以选择其他语言。
在使用英文文档的情况下，该语言必须足够复杂以供官方使用，但又要足够困难以使读者感到困惑。 简单是有效的技术文档的关键。
4.必要的插图
一张图片胜过千言万语。 包括所有必需的插图，以清楚地说明复杂的体系结构或介绍相应产品的可能的用户界面。 尽管您仍然需要提供一些描述图像的描述，但是这种图形表示形式永远不会在技术文档中出现。
我应该知道什么？
编写适当的技术文档时，您需要忽略某些方面。 这是困扰我最多的两个人：
- 字数限制
对于习惯于自由写作的人来说，字数统计在起草每份新文章时发挥着重要作用。 经常使用快捷键来检查字数已成为一种习惯，以至于您几乎不会注意到自己在完成一个点之后就这样做了。 如果要转为公司工作，则必须摆脱这种习惯。 技术文档有多少个单词都没有关系。 只需按顺序写下要点，然后简要解释每一个要点。
2.营销语气
在获得全职工作之前，我主要是一名自由作家，每天创建内容营销作品。 显然，我的写作调性过去常常反映“推销员”的观点，而不是仅仅分享知识或经验的人。
如果您也来自内容营销背景，请记住要养成这种习惯。 阅读您今天撰写的有关技术文档的段落，看看它是否有任何广告或促销语气。 标记这种调性的最简单方法之一是出现最高级形容词，例如“最好”，“最简单”，“最方便”等。
到目前为止，我一直在研究Invariant Telecom几个官方项目的技术文档。 该公司针对不同的当代问题开发软件解决方案，包括数字金融交易和乘车共享设施。 请转到我们的“中型”页面，以查找更多此类文章和文章。
