LogoClawIndex
案例技能关于
LogoClawIndex

project-documentation - 技术项目文档生成

为项目生成准确的技术文档,包括README、API文档、架构决策记录、运行手册和指南

标签

更新于: 2026-03-25
文档技术写作API文档架构部署开发者体验

能力

典型输入

典型输出

该技能可以做什么

  • 编写README
  • 创建API文档
  • 记录架构决策
  • 编写部署指南
  • 创建运行手册
  • 文档化环境变量

输入

  • 项目代码库
  • 架构信息
  • API规范
  • 数据库架构
  • 环境配置
  • 安全策略

输出

  • README.md
  • OpenAPI规范
  • 架构决策记录
  • 部署指南
  • 运行手册
  • CHANGELOG.md
  • CONTRIBUTING.md

要求

  • 项目代码库访问权限
  • 了解项目架构
  • 熟悉文档工具

来源

  • 规范: SKILL.md

ClawIndex

OpenClaw Skills 与 Use Case 索引

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

索引

Skills·
Cases

Meta

关于·
声明·
邮箱·
GitHub
© 2026 ClawIndex 保留所有权利。
编写README
创建API文档
记录架构决策
编写部署指南
项目代码库
架构信息
API规范
README.md
OpenAPI规范
架构决策记录