dev-doc-structure-skill

🥈Silver

@541968679

一个为 Claude Code 设计的开发文档管理 Skill | A comprehensive development documentation system management skill for Claude Code

610Updated 1w ago

Intermediate30min to implementautomation

Saves ~90 min per use

Quick InstallView Source

git clone https://github.com/541968679/dev-doc-structure-skill.git

Works with:

Claude

Overview

About This Skill

一个为 Claude Code 设计的开发文档管理 Skill | A comprehensive development documentation system management skill for Claude Code

Setup & Installation

Quick Install

No install command available. Check the GitHub repository for manual installation instructions.

Alternative Install (Git Clone)

git clone https://github.com/541968679/dev-doc-structure-skill

Requirements

Claude Code or compatible AI agent
Works with: Claude

Quick Start Guide

Install the Skill

Copy the install command above and run it in your terminal.

Open Your AI Agent

Launch Claude Code, Cursor, or your preferred AI coding agent.

Try It Out

Use the prompt template or examples below to test the skill.

Customize

Adapt the skill to your specific use case and workflow.

Usage Examples

Prompt Template

Act as a development documentation manager. Create a structured documentation system for [PROJECT_NAME], a [PROJECT_TYPE] project in [INDUSTRY]. Include sections for API references, code examples, and troubleshooting guides. Ensure the structure is scalable and easy to navigate.

Example Output

# Development Documentation for [PROJECT_NAME]

## Table of Contents
1. [Introduction](#introduction)
2. [API References](#api-references)
3. [Code Examples](#code-examples)
4. [Troubleshooting Guides](#troubleshooting-guides)
5. [FAQs](#faqs)

## Introduction
Welcome to the development documentation for [PROJECT_NAME], a [PROJECT_TYPE] project in the [INDUSTRY] industry. This documentation aims to provide a comprehensive guide for developers to understand, implement, and troubleshoot the project.

## API References
### Endpoints
- **GET /api/data**: Retrieve data from the system.
- **POST /api/data**: Submit data to the system.
- **PUT /api/data/{id}**: Update data in the system.
- **DELETE /api/data/{id}**: Delete data from the system.

## Code Examples
### Python Example
```python
import requests

# Retrieve data from the system
response = requests.get('https://api.example.com/data')
data = response.json()
print(data)
```

## Troubleshooting Guides
### Common Issues
- **Issue 1**: Connection timeout
  - **Solution**: Check your internet connection and ensure the API endpoint is correct.
- **Issue 2**: Invalid data format
  - **Solution**: Ensure the data being submitted adheres to the required format.

## FAQs
### General Questions
- **Q**: What is the rate limit for API requests?
  - **A**: The rate limit is 100 requests per minute.
- **Q**: How do I get an API key?
  - **A**: Contact the system administrator to obtain an API key.