mcpField
D
documentation-production

documentation-production

github.com/nickcrew开发6292 次安装17 周前更新
代码仓库

关于 documentation-production

面向开发者和团队的文档制作技能，可按项目规范生成文档、图表、教程和学习路径，并提供资料查找与校验流程。

主要功能

  1. 01生成专题文档
  2. 02构建项目索引
  3. 03创建 Mermaid 图表
  4. 04编写教程与学习路径
  5. 05遵循项目文档规范
  6. 06校验准确性与一致性

适用场景

  1. 01编写 API 或功能文档
  2. 02创建项目知识库
  3. 03展示系统行为
  4. 04准备入门培训材料

安装

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

$npx skills add https://github.com/nickcrew/claude-cortex --skill documentation-production

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

包含的文件

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

references/
diagrams.md
generate.md
index.md
teacher.md
tutorials.md
writing-process.md

详细介绍

文档编写

概述

提供一致、顺畅的工作流，以多种格式编写文档：专题文档、索引、图表、教程和学习路径。保持输出结构清晰，并符合代码库的文档规范。

适用场景

  • 为组件、API 或功能生成或更新文档
  • 构建项目索引或知识库
  • 为系统行为或架构创建 Mermaid 图表
  • 编写教程、工作坊或学习路径
  • 为入职培训或教育讲解概念

以下情况请避免使用：

  • 请求主要涉及代码更改（请使用实现工作流）
  • 文档类型是无需结构的一次性笔记

快速参考

任务加载参考文件
生成专题文档skills/documentation-production/references/generate.md
项目索引/知识库skills/documentation-production/references/index.md
Mermaid 图表skills/documentation-production/references/diagrams.md
讲解概念/学习路径skills/documentation-production/references/teacher.md
教程/工作坊skills/documentation-production/references/tutorials.md
写作流程与风格skills/documentation-production/references/writing-process.md

工作流

  1. 确定文档类型和目标受众。
  2. 加载相关参考文件，了解结构和模式。
  3. 从代码或现有文档中收集源材料。
  4. 按要求的格式编写文档。
  5. 验证准确性，并确保符合代码库规范。
  6. 总结更改和后续步骤。

输出

  • 文档成果
  • 简要的更改摘要及任何待解决的问题

常见错误

  • 未检查源材料，凭猜测描述行为
  • 混用教程和指南格式，意图不清
  • 创建的图表缺少标签或无障碍说明
  • 更新文档时未同步调整索引或导航链接

评论

支持 Markdown