Menu
生成全面的文档，包括README文件、API文档、代码注释（JSDoc、docstrings、XML）和架构文档。
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
自动分析B站视频内容，下载视频并拆解成帧图片，使用AI分析并生成详细的专题文档或实操教程。
设计RESTful API并生成OpenAPI/Swagger规范文档，遵循行业最佳实践。包括端点命名、请求/响应模式和错误处理模式。
为GitHub Actions、GitLab CI、Azure DevOps和Jenkins生成CI/CD流水线，包含构建、测试、部署阶段、缓存和密钥管理。
全面的代码审查技能，分析代码质量、识别问题、安全漏洞，并提供带严重性评级的改进建议。
设计和优化数据库模式，支持PostgreSQL、MySQL、SQLite和MongoDB。包括ER建模、规范化、索引优化和迁移脚本生成。
创建和管理多容器应用的Docker Compose配置，包含生产级设置、健康检查和网络配置。
| name | documentation-writer |
| description | 生成全面的文档，包括README文件、API文档、代码注释（JSDoc、docstrings、XML）和架构文档。 |
| metadata | {"short-description":"生成项目文档"} |
Generate comprehensive documentation for code, APIs, and projects.
/docs commandYou are a technical writer that creates clear, comprehensive documentation.
# Project Name
Brief description of what this project does.
## Features
- ✅ Feature 1
- ✅ Feature 2
- 🚧 Feature 3 (in progress)
## Quick Start
\`\`\`bash
# Clone the repository
git clone https://github.com/user/project.git
cd project
# Install dependencies
npm install
# Start development server
npm run dev
\`\`\`
## Installation
### Prerequisites
- Node.js >= 18
- PostgreSQL >= 14
### Environment Variables
\`\`\`env
DATABASE_URL=postgresql://user:pass@localhost:5432/db
JWT_SECRET=your-secret-key
\`\`\`
## Usage
\`\`\`typescript
import { Client } from 'my-library';
const client = new Client({ apiKey: 'xxx' });
const result = await client.doSomething();
\`\`\`
## API Reference
### `client.createUser(data)`
Creates a new user.
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| email | string | Yes | User's email |
| name | string | Yes | User's name |
**Returns:** `Promise<User>`
## Contributing
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing`)
3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing`)
5. Open a Pull Request
## License
MIT © [Your Name]
/**
* Creates a new user in the system.
*
* @param {CreateUserDto} data - The user creation data
* @param {string} data.email - User's email address (must be unique)
* @param {string} data.name - User's display name
* @param {string} [data.avatar] - Optional avatar URL
* @returns {Promise<User>} The created user object
* @throws {ValidationError} If email format is invalid
* @throws {DuplicateError} If email already exists
*
* @example
* const user = await userService.createUser({
* email: 'john@example.com',
* name: 'John Doe'
* });
*/
async createUser(data: CreateUserDto): Promise<User> {
// implementation
}
/// <summary>
/// Creates a new user in the system.
/// </summary>
/// <param name="data">The user creation data.</param>
/// <returns>The created user object.</returns>
/// <exception cref="ValidationException">Thrown when email format is invalid.</exception>
/// <exception cref="DuplicateException">Thrown when email already exists.</exception>
/// <example>
/// <code>
/// var user = await userService.CreateUserAsync(new CreateUserDto
/// {
/// Email = "john@example.com",
/// Name = "John Doe"
/// });
/// </code>
/// </example>
public async Task<User> CreateUserAsync(CreateUserDto data)
{
// implementation
}
documentation, readme, api-docs, comments, technical-writing