Starnix 是一个复杂的组件，其开发涉及许多细微的方面。Starnix 也是许多人需要处理的代码库的一部分，即使他们不在 Starnix 团队中也是如此。与其单独向每个人传授这些细微的方面，不如创建更多文档，并更频繁地引导人们参考这些文档。希望人们会在文档中查找信息，这会促使我们编写更多文档，从而形成良性循环。
根据文档回答问题
每当 Starnix 团队收到有关 Starnix 工作方式或如何开发 Starnix 的一般性问题时，我们都应通过撰写涵盖该主题的文档来回答该问题，然后将提问者引导至该文档。这种方法会营造出文档覆盖率完美的假象，因为文档是“及时”创建的，可满足提问者的需求。
这种方法会产生许多小文档片段，无法很好地整合为一个整体。随着这些片段的积累，我们应将它们重构为更全面、更有条理的文档。这种重构过程比从头开始撰写文档要简单，因为其目标不是向文档添加更多信息，而是改进现有信息的组织方式。
实用步骤
- 确定问题：当您在对话中输入一段解释复杂主题的文字时，请停下来。
- 创建文件：在
//docs/development/starnix/中创建文件。 - 粘贴并润色：粘贴说明。添加标题和一句背景信息。
- 更新目录：在
_toc.yaml文件中为新文档添加条目。 如需了解详情，请参阅更新网站导航和目录文件。 - 发布：上传 CL。将链接发送给请求者。
- 稍后重构：不必担心它是否完全合适。将知识纳入知识库是首要任务。
如需详细了解如何创建文档，请参阅为文档做出贡献
不完整的文档
一份粗略但重点突出的文档胜过没有文档。即使文档很短或未涵盖所有可能的极端情况，也不必担心。如果您要回答某个具体问题，则可以使用该问题作为文档的标题。
组织
创建新文档时，您无需担心在文档层次结构中找到最适合的位置。您可以将该文件添加到顶层 starnix 目录或通用 concepts 目录。随着文档数量的增加，我们可以将它们整理成更具结构性的层次结构。
编码智能体
这种方法还会生成对处理我们代码库的编码代理有用的文档。这些编码智能体比人类更受益于此文档，因为编码智能体更难向人类提出实时问题。