LogoClawIndex
案例技能关于
LogoClawIndex

documentation-and-adrs - 文档与架构决策记录

记录架构决策、公共 API 文档以及工程师与 AI Agent 理解代码库所需的上下文信息。

标签

更新于: 2026-09-20
文档架构决策记录软件架构API文档README变更日志

能力

记录架构决策记录编写代码行内设计意图撰写公共 API 文档组织项目 README 文件

典型输入

架构决策上下文公共 API 签名与规范项目快速入门与命令信息

典型输出

docs/decisions/ 中的 ADR 文件行内代码文档与注释API 文档

该技能可以做什么

  • 记录架构决策记录
  • 编写代码行内设计意图
  • 撰写公共 API 文档
  • 组织项目 README 文件
  • 维护项目变更日志
  • 为 AI Agent 记录上下文

输入

  • 架构决策上下文
  • 公共 API 签名与规范
  • 项目快速入门与命令信息
  • 功能更新与 Issue 编号

输出

  • docs/decisions/ 中的 ADR 文件
  • 行内代码文档与注释
  • API 文档
  • README Markdown 文件
  • 变更日志更新
  • Agent 规则文件

要求

    来源

    • 规范: SKILL.md

    ClawIndex

    OpenClaw Skills 与 Use Case 索引

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

    索引

    Skills·
    Cases

    Meta

    关于·
    声明·
    邮箱·
    GitHub
    © 2026 ClawIndex 保留所有权利。