SuperAPI AI 工具集

docs-workflow

写作与研究

查看项目

更新于 10-15 18:31

技能介绍

用途

docs-workflow 是一个用于管理项目文档全生命周期的技能,旨在帮助开发者在项目开发过程中创建、维护和审计文档。它通过四个斜杠命令覆盖文档的初始化、日常维护和定期审计场景,确保 CLAUDE.md、README.md 和 docs/ 目录下的文档与项目实际状态保持一致。

主要能力

命令概览

命令 用途
/docs 主入口,显示可用的子命令
/docs-init 创建 CLAUDE.md + README.md + docs/ 结构
/docs-update 审计并维护所有文档
/docs-claude 仅智能维护 CLAUDE.md

创建内容

CLAUDE.md:为 Claude Code 提供项目专属上下文,包括项目概览与技术栈、开发环境设置命令、架构概览、关键文件位置、常见任务与工作流。提供三种模板:

  • CLAUDE-cloudflare.md:适用于 Cloudflare Workers + Vite + D1 项目
  • CLAUDE-nextjs.md:适用于 Next.js App Router 项目
  • CLAUDE-generic.md:适用于其他任意项目类型

README.md:标准 README,包含项目名称与描述、安装/设置说明、使用示例、配置说明、贡献指南。

docs/ 目录(可选):脚手架文档结构,包括 docs/ARCHITECTURE.md(系统架构)、docs/API.md(API 文档)、docs/DATABASE.md(数据库模式)。

智能维护(/docs-claude)

CLAUDE.md 维护命令会检查以下内容:

  • 技术栈匹配:CLAUDE.md 列出的技术是否与 package.json 一致?提到的版本是否仍然准确?
  • 引用文件:CLAUDE.md 中提到的路径是否仍然存在?是否有新的重要文件未被提及?
  • 章节时效性:“最后更新”日期是否较新?是否存在过时的模式或命令?
  • 关键规则:对于检测到的技术栈,是否包含重要规则?例如 Cloudflare 项目应提及 wrangler.jsonc 模式。

全面审计(/docs-update)

完整文档审计包括:

  • 日期时效性:将文档日期与 git 历史对比,标记超过 30 天未更新的文档
  • 版本引用:检查提到的 npm 包版本,建议更新过时版本
  • 失效链接:验证内部 markdown 链接,检查引用的文件是否存在
  • 冗余内容:识别跨文件的重复内容,建议合并
  • 孤立文件:查找未被任何地方引用的文档,建议归档或删除

使用方式

新项目

在新项目目录中运行:

/docs-init

该命令将:检测项目类型(Cloudflare Workers、Next.js、通用)、从合适模板创建 CLAUDE.md、如缺失则创建 README.md、可选地搭建 docs/ 目录。

已有项目

# 审计所有文档
/docs-update

# 或仅维护 CLAUDE.md
/docs-claude

项目类型检测

技能通过以下指标自动检测项目类型:

指标 项目类型
wrangler.jsonc 或 wrangler.toml Cloudflare Workers
next.config.js 或 next.config.ts Next.js
两者皆无 通用

其他影响模板内容的指标包括:package.json 依赖(React、Vite 等)、数据库配置文件(drizzle.config.ts、prisma/schema.prisma)、认证配置(clerk、better-auth)。

模板

模板位于本技能的 templates/ 目录中:

templates/
├── CLAUDE-cloudflare.md    # Cloudflare Workers 项目
├── CLAUDE-nextjs.md        # Next.js 项目
├── CLAUDE-generic.md       # 通用项目
└── README-template.md      # 标准 README

模板使用占位符:{{PROJECT_NAME}}(从 package.json 或文件夹名检测)、{{DATE}}(当前日期)、{{TECH_STACK}}(检测到的技术)。

适用场景

  • 新项目启动时快速建立文档基础结构
  • 项目发生重大变更后同步更新 CLAUDE.md
  • 发布前进行文档全面审计
  • 每月定期文档维护
  • 与其他技能配合使用:在 /plan-project 之后使用 /docs-init 添加文档;project-planning 生成的 IMPLEMENTATION_PHASES.md 可在 CLAUDE.md 中引用;cloudflare-worker-base 的 Cloudflare 模板包含 Workers 专属模式。

限制

  • 该技能的具体安装方式、依赖要求、运行环境限制暂未提供。
  • 模板的具体内容细节暂未提供。
  • 是否支持除 Cloudflare Workers 和 Next.js 之外的其他框架的专属模板暂未提供。
  • 命令的具体参数选项暂未提供。