mcpField
D
documentation-builder

documentation-builder

github.com/partme-ai文档处理71673 次安装3 周前更新
代码仓库

关于 documentation-builder

documentation-builder 是用于生成和组织项目文档的技能，面向编写者及开发团队。它按文档类型收集代码库与现有资料，并提供生成和验证流程。

主要功能

  1. 01生成项目 README 和快速入门
  2. 02根据代码或 OpenAPI 编写 API 文档
  3. 03创建开发者指南和用户手册
  4. 04从提交记录或发布说明生成变更日志
  5. 05检查示例、链接与文档章节

适用场景

  1. 01为项目补充安装与使用说明
  2. 02根据 OpenAPI 规格整理 API 文档
  3. 03编写开发者入门指南
  4. 04汇总版本变更记录

安装

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

$npx skills add https://github.com/partme-ai/full-stack-skills --skill documentation-builder

安装后在 Claude Code 中输入/documentation-builder确认已加载。

详细介绍

何时使用此技能

在用户希望执行以下操作时使用此技能：

  • 生成包含安装、使用和贡献章节的项目 README
  • 根据代码或 OpenAPI 规范编写 API 文档
  • 编写开发者入门或设置指南
  • 编写用户手册或快速入门教程
  • 为新项目或现有项目规划文档结构
  • 根据提交历史或发行说明生成 CHANGELOG

如何使用此技能

工作流
  1. 确定文档类型 - README、API 参考、用户指南、开发者指南或变更日志
  2. 收集上下文 - 阅读代码库、现有文档和项目结构
  3. 生成文档 - 使用下方的模板和模式
  4. 验证 - 确保所有代码示例都能运行、链接有效且章节完整
README 模板
# Project Name

Brief description of what the project does and why it exists.

## Quick Start

\`\`\`bash
npm install my-package
\`\`\`

\`\`\`typescript
import { MyClient } from 'my-package';
const client = new MyClient({ apiKey: process.env.API_KEY });
const result = await client.query('hello');
\`\`\`

## Features

- Feature one with brief explanation
- Feature two with brief explanation

## Installation

Detailed installation steps for different environments.

## Usage

Detailed usage examples with code snippets.

## API Reference

Link to full API docs or inline reference.

## Contributing

How to contribute, run tests, and submit PRs.

## License

License type and link.
API 文档模式（OpenAPI）
paths:
  /users/{id}:
    get:
      summary: Get user by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: User found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          description: User not found

最佳实践

  1. 从快速入门开始 - 让读者在 2 分钟内开始使用
  2. 提供可运行的代码示例 - 每个 API 端点或函数都应提供可复制粘贴的示例
  3. 让文档紧邻代码 - 将文档与其描述的源代码放在一起
  4. 保持结构一致 - 在所有文档页面中遵循相同的标题层级
  5. 为文档添加版本 - 随代码发行版本一同标记文档版本

关键词

文档编写, documentation, README, API docs, OpenAPI, Swagger, user guide, 用户手册, developer guide, 开发指南, changelog, 技术文档

评论

支持 Markdown