technical-doc-creator

安装量: 43
排名: #16892

安装

npx skills add https://github.com/mhattingpete/claude-skills-marketplace --skill technical-doc-creator

Technical Documentation Creator

Create comprehensive HTML technical documentation with code examples and API workflows.

When to Use "Create API documentation for [endpoints]" "Generate technical docs for [system]" "Document API reference" "Create developer documentation" Components Overview: purpose, key features, tech stack Getting Started: installation, setup, quick start API Reference: endpoints with request/response examples Code Examples: syntax-highlighted code blocks Architecture: system diagram (SVG) Workflows: step-by-step processes HTML Structure

[API/System] Documentation

[System] Documentation

API Endpoint Pattern

GET /api/users/{id}

Retrieve user by ID

Request

curl -X GET https://api.example.com/users/123

Response

{
  "id": 123,
  "name": "John Doe",
  "email": "john@example.com"
}

Code Block Pattern

// Installation
npm install package-name

// Usage
import { feature } from 'package-name';
const result = feature.doSomething();

Workflow Extract API endpoints, methods, parameters Create overview and getting started sections Document each endpoint with examples Add code snippets for common operations Include architecture diagram if relevant Write to [system]-docs.html

Use semantic colors for HTTP methods: GET (green), POST (blue), DELETE (red).

返回排行榜