Skip to main content

文档编写标准

  • Feature 入口进入正式产品需求编写后遵循 PRD 标准;Automation 是 integration-runtime 参考示例,不是所有 Feature 的固定章节副本。
  • Feature 页面拥有稳定产品事实;Guide 和 Runbook 只引用,不复制状态机或接口正文。
  • stub 必须说明已知入口、未知合同、补全条件和 owner。
  • 目标设计、当前实现、验证证据和运行现状必须明确区分。
  • 一次性日期、账号、环境地址、MR、pipeline、命令输出和 activation 结果留在 owning evidence surface。
  • 文档标题使用自然语言,Asset ID 使用英文大写结构;显式锚点一旦被资产 locator 使用即保持稳定。
  • 每页只有一个 h1,链接优先使用站内绝对 route,避免目录移动造成断链。