mcpField
D
diataxis-organize-docs

diataxis-organize-docs

github.com/trogonstack文档处理1161 次安装2 天前更新
代码仓库

关于 diataxis-organize-docs

diataxis-organize-docs 是按 Diátaxis 分类法整理文档的技能，面向文档维护者。它指导内容分类、目录规划、混合文档拆分、导航构建和完成检查。

主要功能

  1. 01按四类文档需求分类
  2. 02规划文档目录层级
  3. 03拆分混合用途文档
  4. 04构建文档导航
  5. 05检查交叉引用与内容完整性

适用场景

  1. 01重组现有文档库
  2. 02规划新文档结构
  3. 03拆分兼具教程与参考内容的文档
  4. 04审查文档导航和链接

安装

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

$npx skills add https://github.com/trogonstack/agentskills --skill diataxis-organize-docs

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

包含的文件

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

references/
classification.md
navigation.md
splitting.md

详细介绍

Diataxis 文档组织

通过将内容归类到 Diataxis 类别并创建结构化的文档层级，重新组织文档。

文档类别

象限侧重点目的用户需求
教程学习通过实践教学“我想学习”
操作指南任务解决具体问题“我想完成 X”
参考资料信息描述机制“我需要了解 Y 的事实”
说明理解阐明概念“我想了解原因”

目录结构

按以下层级组织文档，并根据需要添加主题子目录：

docs/
├── tutorial/            # Learning-oriented
│   ├── getting-started/
│   └── {topic}/
├── how-to/              # Task-oriented
│   ├── {task-category}/
│   └── troubleshooting/
├── reference/           # Information-oriented
│   ├── api/
│   ├── configuration/
│   └── architecture/
├── explanation/         # Understanding-oriented
│   ├── concepts/
│   ├── decisions/
│   └── background/
└── README.md            # Navigation hub

始终使用 docs/README.md 作为根导航文件，绝不要使用 index.md。

写作规范

确保技能说明和生成的文档不包含手动维护的总数或编号章节引用。使用描述性标题和命名链接。对于有序步骤，将每个 Markdown 列表标记写为 1.，以便渲染器自动维护编号。保留理解或使用主题所必需的数字事实。

工作流

仅加载当前任务所需的参考资料：

  1. 分析现有内容。 根据读者需求对每个文件或章节进行分类。对现有内容分类或解决类别划分不明确的问题时，请阅读分类标准。
  2. 映射结构。 将内容分配到上述层级，并确定要保留、移动或拆分的文档。
  3. 拆分混合文档。 当一份文档服务于多个目的时，请阅读拆分指南，了解迁移流程和示例。保留上下文，并在各象限间链接相关内容。
  4. 构建导航。 创建或更新文档中心时，请阅读导航指南以使用其模板。更新因内容移动或拆分而受影响的链接。
  5. 验证并汇报。 按照以下完成检查进行验证。对于审查任务，报告当前状态、分类结果、建议的文件位置以及所需的交叉引用。对于已完成的编辑，总结更改内容和验证结果。根据任务调整报告详略。

完成检查

  • 每份文档只服务于一个目的
  • 教程有明确的学习成果
  • 操作指南能解决具体问题
  • 参考资料完整且准确
  • 说明提供真正的见解
  • 交叉引用能够关联相关内容，并在移动后仍然有效
  • docs/README.md 清楚说明用户意图
  • 没有内容孤立、重复或丢失

评论

支持 Markdown