mcpField
D
documentation-builder

documentation-builder

github.com/partme-aiDocuments71673 installsUpdated 3w ago
Repository

About documentation-builder

documentation-builder is a skill for generating and organizing project documentation for writers and development teams. It gathers context from code and existing docs, then provides a workflow for drafting and validation.

Key features

  1. 01Generate project READMEs and quick starts
  2. 02Create API docs from code or OpenAPI
  3. 03Draft developer guides and user manuals
  4. 04Generate changelogs from commits or releases
  5. 05Check examples, links, and sections

Use cases

  1. 01Add installation and usage instructions to a project
  2. 02Document APIs from OpenAPI specifications
  3. 03Write developer onboarding guides
  4. 04Summarize changes for a release

Install

Copy the command and run it in a terminal.

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

After installing, type/documentation-builderin Claude Code to confirm it loaded.

Details

From the project README

When to use this skill

Use this skill whenever the user wants to:

  • Generate a project README with installation, usage, and contributing sections
  • Create API documentation from code or OpenAPI specs
  • Write developer onboarding or setup guides
  • Build user manuals or quick-start tutorials
  • Structure documentation for a new or existing project
  • Generate a CHANGELOG from commit history or release notes

How to use this skill

Workflow
  1. Identify the doc type - README, API reference, user guide, developer guide, or changelog
  2. Gather context - Read the codebase, existing docs, and project structure
  3. Generate documentation - Use the templates and patterns below
  4. Validate - Ensure all code examples run, links resolve, and sections are complete
README Template
# 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 Documentation Pattern (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

Best Practices

  1. Start with a quick-start - Let readers get running in under 2 minutes
  2. Include runnable code examples - Every API endpoint or function should have a copy-paste example
  3. Keep docs next to code - Co-locate documentation with the source it describes
  4. Use consistent structure - Follow the same heading hierarchy across all doc pages
  5. Version your docs - Tag documentation alongside code releases

Keywords

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

Comments

Markdown supported