mcpField
D
docs-workflow

docs-workflow

github.com/jezweb开发1.1k364 次安装3 周前更新
代码仓库

关于 docs-workflow

用于项目文档全生命周期管理的技能，适合维护项目说明的开发者。可创建文档结构，并检查陈旧内容、失效链接和版本信息。

主要功能

  1. 01初始化 CLAUDE.md、README.md 与 docs/
  2. 02按项目类型选择文档模板
  3. 03检查技术栈与文档是否一致
  4. 04审计日期、版本、链接及重复内容

适用场景

  1. 01为新项目搭建文档结构
  2. 02重大改动后更新 CLAUDE.md
  3. 03发布前检查文档的准确性与完整性

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/jezweb/claude-skills --skill docs-workflow

安装后在 Claude Code 中输入/docs-workflow确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

README.md
.claude-plugin/
plugin.json
commands/
docs-claude.md
docs-init.md
docs-update.md
docs.md
rules/
claude-md-patterns.md
templates/
CLAUDE-cloudflare.md
CLAUDE-generic.md
CLAUDE-nextjs.md
README-template.md

详细介绍

docs-workflow

最后更新：2026-01-11 用途：管理项目文档的整个生命周期

概述

此技能可帮助你：

  • 初始化新项目的文档（CLAUDE.md、README.md、docs/）
  • 维护 CLAUDE.md，使其与项目实际状态保持一致
  • 审查所有文档，检查内容是否过时、链接是否失效、版本是否陈旧

命令

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

快速开始

新项目
# In a new project directory
/docs-init

此命令将：

  1. 检测项目类型（Cloudflare Workers、Next.js、通用）
  2. 根据适用的模板创建 CLAUDE.md
  3. 如果 README.md 不存在，则创建它
  4. 可选地搭建 docs/ 目录
现有项目
# Audit all documentation
/docs-update

# Or just maintain CLAUDE.md
/docs-claude

创建的内容

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 维护命令会检查：

  1. 技术栈匹配情况

    • CLAUDE.md 中列出的技术是否与 package.json 相符？
    • 提及的版本是否仍然准确？

  2. 引用的文件

    • CLAUDE.md 中提及的路径是否仍然存在？
    • 是否有未提及的新重要文件？

  3. 章节时效性

    • “最后更新”日期是否为近期？
    • 是否存在过时的模式或命令？

  4. 关键规则

    • 对于检测到的技术栈，是否包含重要规则？
    • 例如，Cloudflare 项目应提及 wrangler.jsonc 模式
/docs-update 功能

全面审查文档，包括：

  1. 日期时效性

    • 将文档日期与 git 历史记录进行比较
    • 标记超过 30 天未更新的文档

  2. 版本引用

    • 检查文档中提及的 npm 包版本
    • 建议更新过时的版本

  3. 失效链接

    • 验证内部 Markdown 链接
    • 检查引用的文件是否存在

  4. 内容冗余

    • 识别不同文件中的重复内容
    • 建议整合内容

  5. 孤立文件

    • 查找未在任何地方引用的文档
    • 建议归档或删除

项目类型检测

此技能通过查找以下内容自动检测项目类型：

指标项目类型
wrangler.jsonc 或 wrangler.tomlCloudflare Workers
next.config.js 或 next.config.tsNext.js
两者都没有通用

其他指标会影响模板内容：

  • package.json 依赖项（React、Vite 等）
  • 数据库配置文件（drizzle.config.ts、prisma/schema.prisma）
  • 身份验证配置（clerk、better-auth）

与其他技能集成

  • project-workflow：在 /plan-project 后运行 /docs-init，添加文档
  • project-planning：在 CLAUDE.md 中引用生成的 IMPLEMENTATION_PHASES.md
  • cloudflare-worker-base：Cloudflare 模板包含 Workers 专属模式

最佳实践

何时运行各命令
情况命令
新项目/docs-init
重大变更后/docs-claude
发布前/docs-update
每月维护/docs-update
CLAUDE.md 指南
  1. 保持内容最新 - 修改时更新“最后更新”日期
  2. 聚焦项目特定内容 - 不要重复通用技术文档
  3. 包含常见任务 - 列出经常运行的命令
  4. 引用而非重复 - 详细内容请链接到 docs/

模板

模板位于此技能中的 templates/：

templates/
├── CLAUDE-cloudflare.md    # Cloudflare Workers projects
├── CLAUDE-nextjs.md        # Next.js projects
├── CLAUDE-generic.md       # Generic projects
└── README-template.md      # Standard README

模板使用以下占位符：

  • {{PROJECT_NAME}} - 从 package.json 或文件夹名称中检测
  • {{DATE}} - 当前日期
  • {{TECH_STACK}} - 检测到的技术

评论

支持 Markdown