OGT Docs

📚 文档驱动开发治理框架

文档即真相工作流管理工具,通过 docs/ 目录统一管理定义、规则与任务,实现文档优先的软件开发治理。

收藏
4.4k
安装
1.3k
版本
1.0.0
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

ogt-docs 是一套 Documentation-as-Source-of-Truth(文档即真相)的工作流框架,核心理念是文档定义事物本质,代码仅负责实现。它要求将 docs/ 目录作为项目决策的单一数据源,包含五大结构:definitions(定义)、rules(规则)、todo(任务)、guides(指南)、social(营销)。

该 Skill 采用文件夹即实体模式——每个可文档化项目均为独立文件夹,内含主文档、辅助文件及状态标记文件(dot-files),支持原子化版本追踪与状态流转。

显著优点

  • 治理清晰:强制文档优先,解决"代码与需求脱节"顽疾
  • 结构完整:覆盖从业务定义、编码规范到任务管理的全生命周期
  • 可扩展性强:通过 20+ 个子 Skill 实现精细化场景覆盖
  • 状态透明:以 dot-files(如 .blocked.approved)替代字段编辑,Git 原生友好

潜在局限

  • 学习曲线陡峭:需团队接受"文档冲突时代码为错"的文化转变
  • 维护成本高:文档与代码双向同步需要纪律性
  • 适用边界:更适合中大型企业/复杂项目,小型项目可能过度设计
  • 工具链依赖:需配合 Git 工作流及可能的 CI 校验脚本

适合人群

  • 技术负责人/架构师:建立团队级文档规范
  • 中大型开发团队(10+人):治理复杂项目边界
  • 追求可追溯性的合规驱动型组织

常规风险

  • 形式主义陷阱:文档沦为摆设,与实际开发割裂
  • 版本漂移:文档更新滞后于代码迭代
  • 权限管理缺失:dot-files 可被任意修改,缺乏强制校验机制
  • 迁移成本:存量项目重构 docs 结构工作量巨大

OGT Docs 内容

手动下载zip · 4.2 kB
skill-card.mdtext/markdown
请选择文件