LogoClawIndex
案例技能关于
LogoClawIndex

scaffold-docs - 通过分阶段迭代和用户审核为代码库构建或更新文档。

采用自顶向下分阶段迭代与用户审核机制,为代码库创建或更新 Getting Started、Diving Deeper 及 Reference 文档。

标签

更新于: 2026-09-17

能力

典型输入

典型输出

该技能可以做什么

  • 分析代码库结构与目标读者
  • 构建快速入门教程文档
  • 构建深入主题讲解文档
  • 构建模块参考 API 文档
  • 代码变更后更新现有文档

输入

  • 代码库源代码
  • 用户审核反馈
  • 现有文档文件
  • .scaffold-docs.yml 元数据文件

输出

  • getting-started.md 文档文件
  • diving-deeper 主题文档文件
  • reference 模块参考文件
  • overall-structure.md 结构文件
  • .scaffold-docs.yml 元数据文件

要求

  • 文件系统读写权限
  • 用于提交跟踪的 Git 仓库

来源

  • 规范: SKILL.md

ClawIndex

OpenClaw Skills 与 Use Case 索引

ClawIndex 是一个生态驱动的 OpenClaw Skills 与真实 Use Case 索引站。

索引

Skills·
Cases

Meta

关于·
声明·
邮箱·
GitHub
© 2026 ClawIndex 保留所有权利。
文档生成
技术写作
代码库
开发者工具
分析代码库结构与目标读者
构建快速入门教程文档
构建深入主题讲解文档
构建模块参考 API 文档
代码库源代码
用户审核反馈
现有文档文件
getting-started.md 文档文件
diving-deeper 主题文档文件
reference 模块参考文件