Menú
De forma predeterminada está seleccionado el prompt que primero revisa el origen. Puedes cambiar a un comando directo o descargar una copia local.
Lee SKILL.md y los archivos complementarios que muestra SkillsMP antes de decidir si quieres instalarlo.
Instalar con Codex o Claude Copia este prompt, pégalo en Codex, Claude u otro asistente, y deja que revise la página de la skill y la instale por ti.
Un comando directo omite el prompt de revisión. Revisa el origen antes de ejecutarlo.
npx skills add https://github.com/AIDotNet/MoYuCode --skill documentation-writerEl comando permanece en una sola línea. Desplázate horizontalmente para revisarlo antes de copiarlo.
¿Prefieres una copia local? Descarga los archivos que SkillsMP tiene disponibles ahora.
Basado en la clasificación ocupacional SOC
Mostrando SKILL.md
| 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