添加新文档

1. 确定受众和信息的预期用途。
2. 命名标题。
3. 按照撰写您的贡献。
4. 将您的贡献提交到 GitHub 存储库。
5. 执行，直到您的贡献被合并。

好的文档需要从了解读者的阅读目的，知识面以及希望他们如何处理这些信息开始。否则，您无法确定要提供的信息的范围和深度、 理想结构和必要的支持信息。以下示例描述如何在实际操作中践行该准则：

• 读者需要执行特定的任务：告诉他们如何识别哪些是需要执行的任务，并以编号步骤列表的形式提供任务细节，而不是简单地概括性地描述任务。

• 读者是运维人员，而不是软件工程师（SWE）：提供执行脚本，而不是开发人员指南中的代码示例链接。

• 读者需要扩展产品的功能：提供一个如何扩展功能的示例，并使用简化方案进行说明。

• 读者需要理解复杂的功能关系：提供一个显示关系的图表，而不是编写大量文字信息供阅读理解。

如果您需要帮助特定内容的受众，我们很乐意在文档工作组每两周一次的会议上帮助您并回答您的所有问题。

了解受众和所提供信息的预期用途后，您可以选择最能满足他们需求的内容类型。为了方便您选择， 下表提供了受支持的内容类型、预期受众及每种类型文档的实施目标：

为您的主题选择一个标题，该标题具有您希望搜索引擎查找的关键字。Istio 中的所有内容文件都被命名为 ， 但是每个内容文件都存放在用标题关键字命名的文件夹中，并用连字符分隔，所有字母均小写。文件夹名称应尽可能短， 以使交叉引用更易于创建和维护。

如果您想了解有关发表文稿的方式和时间的更多信息，请参阅， 以了解我们如何使用分支和 cherry picking 来发布我们的内容。