메뉴
Documentation patterns for Markdown formatting, structure, voice/tone, and technical writing best practices. Use for user guides, API docs, code comments, and content reviews.
기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.
설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
직접 명령은 검토 Prompt를 거치지 않습니다. 실행하기 전에 소스를 확인하세요.
npx skills add https://github.com/kennedym-ds/copilot_orchestrator --skill documentation-style명령은 한 줄로 유지됩니다. 복사하기 전에 가로로 스크롤해 전체 내용을 확인하세요.
로컬 사본을 원하시나요? SkillsMP에서 현재 제공할 수 있는 파일을 다운로드하세요.
Runtime budget enforcement for conductor workflows. Tracks model tier usage, delegation count, and estimated token cost across phases. Provides soft/hard limits with escalation patterns to prevent runaway sessions.
Agent-to-agent routing patterns for autonomous delegation via #runSubagent. Defines keyword matching, context templates, model preferences, escalation rules, and invocation guardrails. Use for routing decisions, subagent dispatch, delegation context preparation, and handoff target selection.
WCAG 2.1 Level AA compliance patterns for semantic HTML, ARIA, keyboard navigation, and screen reader compatibility. Use for accessibility audits, ARIA reviews, and POUR principle validation.
SOC 직업 분류 기준
SKILL.md 표시 중
| name | documentation-style |
| description | Documentation patterns for Markdown formatting, structure, voice/tone, and technical writing best practices. Use for user guides, API docs, code comments, and content reviews. |
| user-invocable | true |
| argument-hint | [component or feature to document or review] |
Provides documentation patterns for Markdown formatting, structure, voice/tone, and technical writing best practices across user guides, API docs, and code comments.
This skill teaches documentation agents how to create clear, consistent, well-structured documentation following industry best practices. It covers Markdown conventions, information architecture, writing style (active voice, concise sentences), code examples, and accessibility considerations for documentation.
Trigger Phrases: "write documentation", "create user guide", "document this API", "update README", "onboarding guide"
Context Patterns: New feature completion, API endpoint additions, architecture changes, refactoring tasks
Standard Sections:
# H1: Document Title (one per file)
Brief overview paragraph explaining purpose.
## H2: Major Section
Content with **bold** for emphasis, *italic* for terms, `code` for technical elements.
### H3: Subsection
- Bullet lists for unordered items
- Keep items parallel in structure
1. Numbered lists for sequential steps
2. Start each item with action verb
3. Include expected outcomes
### Code Blocks
\`\`\`javascript
// Always specify language for syntax highlighting
const example = 'Use comments to explain why, not what';
\`\`\`
### Tables
| Column 1 | Column 2 | Column 3 |
|----------|----------|----------|
| Data | Data | Data |
### Links
[Descriptive link text](https://example.com) not "click here"
### Images
Do:
Don't:
Complete and Runnable:
# ✅ GOOD: Complete example with imports and context
import requests
def get_user(user_id):
"""Fetch user data from API."""
response = requests.get(f'https://api.example.com/users/{user_id}')
response.raise_for_status() # Handle errors
return response.json()
# Usage
user = get_user(123)
print(user['name'])
# ❌ BAD: Incomplete snippet, unclear context
response = requests.get(url)
return response.json()
Include Error Handling:
// ✅ GOOD: Shows both success and error paths
try {
const user = await fetchUser(userId);
console.log(user.name);
} catch (error) {
if (error.response?.status === 404) {
console.error('User not found');
} else {
console.error('Failed to fetch user:', error.message);
}
}
## `functionName(param1, param2)`
Brief one-line description of what the function does.
### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| `param1` | string | Yes | Description of param1 |
| `param2` | number | No | Description of param2 (default: 0) |
### Returns
`Promise<User>` - User object containing `id`, `name`, `email`.
### Throws
- `ValidationError` - If param1 is empty or invalid format
- `NotFoundError` - If user with specified ID doesn't exist
### Example
\`\`\`javascript
const user = await functionName('john@example.com', 10);
console.log(user.name); // 'John Doe'
\`\`\`
### See Also
- [Related function](#related-function)
- [Configuration guide](./configuration.md)
# User Management API
RESTful API for managing user accounts and profiles.
**Base URL:** `https://api.example.com/v1`
**Authentication:** Bearer token in `Authorization` header
## Endpoints
### Create User
`POST /users`
Creates a new user account.
**Request Body:**
\`\`\`json
{
"email": "user@example.com",
"name": "John Doe",
"role": "user"
}
\`\`\`
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| email | string | Yes | Valid email address (unique) |
| name | string | Yes | Full name (2-100 characters) |
| role | string | No | User role: `user` or `admin` (default: `user`) |
**Success Response (201):**
\`\`\`json
{
"user": {
"id": "usr_abc123",
"email": "user@example.com",
"name": "John Doe",
"role": "user",
"created_at": "2026-01-09T10:30:00Z"
}
}
\`\`\`
**Error Responses:**
| Status | Code | Description |
|--------|------|-------------|
| 400 | `invalid_email` | Email format invalid |
| 409 | `email_exists` | Email already registered |
| 401 | `unauthorized` | Missing or invalid auth token |
**Example Request:**
\`\`\`bash
curl -X POST https://api.example.com/v1/users \\
-H "Authorization: Bearer YOUR_TOKEN" \\
-H "Content-Type: application/json" \\
-d '{"email":"user@example.com","name":"John Doe"}'
\`\`\`
**Rate Limits:** 100 requests/hour per API key
**See Also:**
- [Authentication Guide](./authentication.md)
- [Rate Limiting](./rate-limits.md)
instructions/languages/markdown.instructions.md — repository Markdown guardrailsinstructions/compliance/documentation.instructions.md — documentation compliance overlaydocs/templates/ — reusable documentation templates and canonical structures