工程开发
Global Documentation avatar

Global Documentation

确保技术项目符合标准化的全局文档规范,维护存储库与代理工作流程的一致性。

简介

此技能作为技术文档编写的专业质量保证机制,为代理程序提供基于既定存储库标准的严格遵循协议。它专为软件工程师、技术写作者以及管理大型代码库的 AI 代理程序设计,确保项目级文档、架构规范和开发指南与全局标准保持同步。通过运用此技能,代理程序会将本地编辑内容与中央文档指令进行交叉比对,防止格式偏差,并确保 README 文件、架构清单和技术规范遵循组织既定的结构准则。

  • 根据强制性的全局编码和风格标准验证技术文档。

  • 监控个别模块 README 与中央文档文件夹之间的一致性。

  • 协助自动审查架构规范(例如 architecture-refactoring/spec.md),确保符合全局项目需求。

  • 为文档更新提供情境感知指导,确保正确标记与交叉链接新文件。

  • 支持与 agent-os/standards/global/documentation.md 整合,以便在编辑过程中进行实时规则评估。

  • 每当您在存储库内修改、创建或稽核文档文件时,请使用此技能以确保它们符合强制性的结构规则。

  • 预期输入:Markdown 文档文件或规范清单。输出:合规性检查、结构建议与标准化格式调整。

  • 限制:此技能依赖于 agent-os/standards/global/documentation.md 文件的存在;请确保此路径在您的环境中可访问。

  • 最佳实践:在完成合并请求或对技术规范进行重大更新之前,请务必调用此技能,以验证全局交叉参考是否有效,并确认格式符合组织模板。

  • 适用于各种技术生态系统,包括 Go 后端、像 Beads 这样的 CLI 优先问题追踪器,以及复杂的架构重构文档。

仓库统计

Star 数
3
Fork 数
1
Open Issue 数
1
主要语言
Go
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 22:49
在 GitHub 查看