docs-writer¶

Skill 简介¶

docs-writer 是一个基于 OpenClaw 的 AI 驱动型文档生成工具，旨在帮助开发者自动生成和维护高质量的技术文档。无论是初创项目还是大型软件系统，文档的编写与管理一直是开发流程中不可或缺但又繁琐的一部分。docs-writer 通过分析代码库，自动生成项目所需的各类文档，如 README 文件、API 文档、函数注释（以 JSDoc 为例）以及各种指南和教程，从而大幅提升开发效率，确保文档与代码始终保持同步。

解决的问题¶

在软件开发过程中，编写和维护文档往往需要耗费大量的时间和精力。尤其是在项目快速迭代或团队协作频繁的情况下，文档很容易变得过时或不一致。docs-writer 通过自动化文档生成流程，帮助开发者减轻负担，确保文档的及时性和准确性。此外，它还支持多种文档格式，满足不同开发阶段和团队的需求。

主要功能¶

docs-writer 提供了多种核心功能，涵盖了从项目初始化到持续维护的各个环节：

1. README 文件生成¶

功能说明：docs-writer 能够根据代码库的结构和内容，自动生成详细的 README 文件。README 包含项目描述、快速入门指南、主要功能、使用方法、API 说明以及配置说明等关键信息，帮助新成员快速了解项目概况。

示例：

# AI2SQL

Convert natural language to SQL queries.

## Quick Start
npm install && npm run dev
Type: "Show users who signed up this week"

## Features
- MySQL, PostgreSQL, SQLite support
- Schema-aware queries
- CSV export

2. API 文档生成¶

功能说明：该功能支持对 API 端点进行详细描述，包括参数说明、返回值、代码示例以及错误处理案例等。开发者只需提供端点信息，docs-writer 便能生成完整的 API 文档。

示例：

You: "Document the /api/generate endpoint"
Scribe: [Parameters, return values, code examples, error cases]

3. 函数注释（JSDoc）生成¶

功能说明：docs-writer 能够为代码中的函数自动添加 JSDoc 注释，涵盖参数、返回值、示例用法以及可能抛出的异常。这对于提升代码可读性和维护性非常有帮助。

示例：

/**
 * Generates SQL from natural language.
 * @param prompt - Description of desired query
 * @param options.dialect - SQL dialect (default: postgresql)
 * @returns Generated SQL and explanation
 * @example
 * await generateSQL("Find active users");
 */

4. 设置指南编写¶

功能说明：为新加入的开发者提供详细的设置指南，包括环境配置、依赖安装、运行步骤以及常见问题排查等内容，帮助团队成员快速上手项目。

示例：

You: "Write a setup guide for new developers"
Scribe: [Prerequisites, step-by-step, expected output, common errors]

5. 定期更新¶

功能说明：docs-writer 支持在代码发生重大变更后自动更新文档，确保文档始终与代码库保持同步。这对于维护文档的准确性和及时性至关重要。

使用场景¶

1. 新项目启动¶

在新项目启动时，开发者可以使用 docs-writer 快速生成基础的 README 文件和设置指南，为团队成员提供清晰的项目介绍和开发指引。

2. API 文档编写¶

在开发 API 时，docs-writer 可以自动生成详细的 API 文档，节省手动编写的时间，并确保文档的准确性和完整性。

3. 代码库维护¶

在代码库频繁更新时，docs-writer 能够自动同步文档内容，避免文档与代码脱节，提高团队协作效率。

4. 团队协作¶

对于大型团队，docs-writer 可以帮助统一文档格式和内容风格，提升团队整体文档质量，促进知识共享。

5. 持续集成¶

docs-writer 可以集成到持续集成（CI）流程中，在每次代码提交或合并时自动更新文档，确保文档的实时性和一致性。

如何使用¶

1. 安装¶

首先，确保你已经安装了 OpenClaw CLI 工具。然后，按照以下步骤安装 docs-writer：

mkdir -p ~/.openclaw/agents/docs-writer/agent
cp SOUL.md ~/.openclaw/agents/docs-writer/agent/
openclaw agents add docs-writer --workspace ~/.openclaw/agents/docs-writer

2. 配置¶

在项目根目录下创建一个配置文件（可选），指定文档生成的具体参数和格式。例如：

{
  "outputDir": "docs",
  "formats": ["README", "API", "JSDoc"]
}

3. 生成文档¶

使用以下命令生成文档：

openclaw chat docs-writer "Write a README for this project"
openclaw chat docs-writer "Document the /api/generate endpoint"
openclaw chat docs-writer "Add JSDoc to this function"

示例¶

1. 生成 README 文件¶

openclaw chat docs-writer "Write a README for this project"

输出：

# AI2SQL

Convert natural language to SQL queries.

## Quick Start
npm install && npm run dev
Type: "Show users who signed up this week"

## Features
- MySQL, PostgreSQL, SQLite support
- Schema-aware queries
- CSV export

2. 生成 JSDoc 注释¶

openclaw chat docs-writer "Add JSDoc to this function"

输出：

/**
 * Generates SQL from natural language.
 * @param prompt - Description of desired query
 * @param options.dialect - SQL dialect (default: postgresql)
 * @returns Generated SQL and explanation
 * @example
 * await generateSQL("Find active users");
 */

总结¶

docs-writer 是一个强大的 AI 驱动型文档生成工具，专为开发者设计。它不仅能够自动生成多种类型的文档，还能确保文档与代码的同步，提升开发效率和文档质量。无论是个人开发者还是大型团队，docs-writer 都能满足不同场景下的文档需求，帮助团队专注于核心开发任务。对于希望简化文档管理流程、提升文档质量的开发者来说，docs-writer 是一个不可或缺的工具。

docs-writer