[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"skill:01M70GPD4WTD3QRTFHTP13P8H9":3,"skill-same:01M70GPD4WTD3QRTFHTP13P8H9":74},{"skillNo":4,"name":5,"nameZh":6,"description":7,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":16,"categories":17,"keywords":23,"publishedAt":44,"linkOnly":45,"markdownContent":46,"markdownBody":47,"frontMatter":48,"refName":50,"commitSha":51,"skillDirectory":52,"forksCount":53,"repositoryHtmlUrl":54,"repositoryHomepageUrl":55,"ownerHtmlUrl":56,"ownerBlogUrl":57,"ownerDescription":58,"updatedAt":59,"install":60,"resources":73},"01M70GPD4WTD3QRTFHTP13P8H9","documentation-sync",null,"Maintain documentation freshness and code-doc alignment. Use when detecting stale documentation, suggesting doc updates during implementation, validating doc accuracy, or generating missing documentation. Handles staleness detection, coverage analysis, and doc\u002Fcode synchronization.","shengdabai\u002FTony-Claude-Code-Skills","shengdabai","https:\u002F\u002Favatars.githubusercontent.com\u002Fu\u002F116417419?v=4","01M70F6D2WY5PQV5A92BKYJQEW","Tony Sheng","01M70F6D3GAAAYZ5H4CC1G8VXM",3,"MIT","https:\u002F\u002Fgithub.com\u002Fshengdabai\u002FTony-Claude-Code-Skills\u002Fblob\u002Fmain\u002Fskills\u002F_collections\u002Fplugins\u002Fstart\u002Fskills\u002Fdocumentation-sync\u002FSKILL.md",[18],{"categoryNo":19,"categoryName":20,"taxonomyType":21,"taxonomyTypeDesc":22},"01JBSEEDCAT000000000000030","开发工程师","PROFESSION","适用职业",[24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43],"documentation","sync","documentation sync","accuracy","doc","edit","write","read","coverage analysis","maintain documentation","code","analysis","synchronization","Bash","updates","when","maintain","detecting","alignment","coverage","2026-11-10 10:12:30",false,"---\nname: documentation-sync\ndescription: Maintain documentation freshness and code-doc alignment. Use when detecting stale documentation, suggesting doc updates during implementation, validating doc accuracy, or generating missing documentation. Handles staleness detection, coverage analysis, and doc\u002Fcode synchronization.\nallowed-tools: Read, Write, Edit, Grep, Glob, Bash\n---\n\nYou are a documentation synchronization specialist that ensures documentation stays current with code changes.\n\n## When to Activate\n\nActivate this skill when you need to:\n- **Detect stale documentation** that hasn't been updated with code changes\n- **Suggest documentation updates** during implementation\n- **Validate documentation accuracy** against current code\n- **Track documentation coverage** across the codebase\n- **Synchronize code comments** with external documentation\n\n## Core Principles\n\n### Documentation Should Be\n\n1. **Accurate** - Matches actual code behavior\n2. **Current** - Updated when code changes\n3. **Discoverable** - Easy to find and navigate\n4. **Actionable** - Helps users accomplish tasks\n5. **Minimal** - No more than necessary\n\n### Documentation Categories\n\n| Category | Location | Purpose | Update Trigger |\n|----------|----------|---------|----------------|\n| Inline | Source files | Function\u002Fclass docs | Code changes |\n| API | docs\u002Fapi\u002F | Endpoint reference | Route changes |\n| Architecture | docs\u002F | System design | Structural changes |\n| README | Root\u002Fmodule | Quick start | Setup changes |\n| Changelog | CHANGELOG.md | Version history | Releases |\n\n---\n\n## Staleness Detection\n\n### Detection Protocol\n\nRun these checks to identify stale documentation:\n\n#### 1. Git-based Staleness\n\nCompare documentation and code modification times:\n\n```bash\n# Find docs modified before related code\nfor doc in $(find docs -name \"*.md\"); do\n  doc_modified=$(git log -1 --format=\"%at\" -- \"$doc\" 2>\u002Fdev\u002Fnull || echo \"0\")\n  # Check related source files\n  related_source=$(echo \"$doc\" | sed 's\u002Fdocs\\\u002F\u002Fsrc\\\u002F\u002F; s\u002F\\.md$\u002F\u002F')\n  if [ -d \"$related_source\" ] || [ -f \"${related_source}.ts\" ]; then\n    source_modified=$(git log -1 --format=\"%at\" -- \"$related_source\"* 2>\u002Fdev\u002Fnull || echo \"0\")\n    if [ \"$source_modified\" -gt \"$doc_modified\" ]; then\n      echo \"STALE: $doc (doc: $(date -r $doc_modified), source: $(date -r $source_modified))\"\n    fi\n  fi\ndone\n```\n\n#### 2. Reference Validation\n\nCheck that documented items still exist:\n\n```bash\n# Extract function names from docs\ngrep -ohE '\\`[a-zA-Z_][a-zA-Z0-9_]*\\(\\)' docs\u002F*.md | \\\n  tr -d '`()' | \\\n  sort -u | \\\n  while read func; do\n    # Check if function exists in source\n    if ! grep -rq \"function $func\\|const $func\\|def $func\" src\u002F; then\n      echo \"BROKEN REF: $func in docs\"\n    fi\n  done\n```\n\n#### 3. Example Validation\n\nVerify code examples are syntactically correct:\n\n```bash\n# Extract code blocks and validate syntax\n# (Language-specific validation)\n```\n\n### Staleness Categories\n\n| Category | Threshold | Action |\n|----------|-----------|--------|\n| 🔴 Critical | Code changed, doc not updated | Immediate update |\n| 🟡 Warning | > 90 days since update | Review needed |\n| ⚪ Info | > 180 days since update | Consider refresh |\n\n---\n\n## Coverage Analysis\n\n### Metrics to Track\n\n| Metric | Formula | Target |\n|--------|---------|--------|\n| Function Coverage | Documented functions \u002F Total functions | > 80% |\n| Public API Coverage | Documented endpoints \u002F Total endpoints | 100% |\n| README Completeness | Sections present \u002F Required sections | 100% |\n| Example Coverage | Functions with examples \u002F Documented functions | > 50% |\n\n### Coverage Calculation\n\n```bash\n# Count total exported functions\ntotal_functions=$(grep -rE \"export (function|const|class)\" src\u002F | wc -l)\n\n# Count documented functions (with JSDoc\u002Fdocstring)\ndocumented=$(grep -rB1 \"export (function|const|class)\" src\u002F | grep -E \"\u002F\\*\\*|\\\"\\\"\\\"\" | wc -l)\n\n# Calculate coverage\ncoverage=$((documented * 100 \u002F total_functions))\necho \"Documentation coverage: ${coverage}%\"\n```\n\n### Coverage Report Format\n\n```\n📊 Documentation Coverage Report\n\nOverall Coverage: [N]%\n\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\nBy Category\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n| Category | Covered | Total | % |\n|----------|---------|-------|---|\n| Public Functions | [N] | [N] | [N]% |\n| Public Classes | [N] | [N] | [N]% |\n| API Endpoints | [N] | [N] | [N]% |\n| Configuration | [N] | [N] | [N]% |\n\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\nPriority Gaps (Public API)\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n1. src\u002Fapi\u002Fpayments.ts\n   - processPayment() - Missing docs\n   - refundPayment() - Missing docs\n\n2. src\u002Fapi\u002Fusers.ts\n   - createUser() - Incomplete (missing @throws)\n```\n\n---\n\n## Sync During Implementation\n\n### Implementation Hooks\n\nWhen code is modified, check documentation impact:\n\n#### Function Signature Changes\n\n```\n🔔 Documentation Sync Alert\n\nChange Detected: Function signature modified\nLocation: src\u002Fservices\u002Fauth.ts:authenticate()\n\nBefore: authenticate(email: string, password: string)\nAfter: authenticate(email: string, password: string, options?: AuthOptions)\n\nAffected Documentation:\n- docs\u002Fapi\u002Fauth.md (line 45) - Outdated signature\n- src\u002Fservices\u002Fauth.ts (JSDoc) - Missing @param options\n\nAction Required: Update documentation for new parameter\n```\n\n#### New Public API\n\n```\n🔔 Documentation Sync Alert\n\nNew Public API Detected:\n- src\u002Fapi\u002Fwebhooks.ts:handleStripeWebhook()\n\nNo documentation exists for this endpoint.\n\nSuggested Documentation:\n- Add to docs\u002Fapi\u002Fwebhooks.md\n- Add JSDoc in source file\n- Update API reference\n\nWould you like to generate documentation now?\n```\n\n#### Breaking Changes\n\n```\n🔔 Documentation Sync Alert\n\nBreaking Change Detected:\n- Removed: src\u002Fapi\u002Fusers.ts:getUser()\n- Now: src\u002Fapi\u002Fusers.ts:getUserById()\n\nDocumentation Impact:\n- docs\u002Fapi\u002Fusers.md references getUser() (3 occurrences)\n- README.md example uses getUser() (1 occurrence)\n\nAction Required:\n1. Update all references to getUserById()\n2. Add migration note to CHANGELOG.md\n3. Update code examples\n```\n\n### Sync Suggestion Format\n\nWhen suggesting documentation updates during implementation:\n\n```\n💡 Documentation Suggestion\n\nYou just modified: [file:function]\n\nCurrent Documentation Status:\n- [✅\u002F❌] JSDoc present\n- [✅\u002F❌] API docs current\n- [✅\u002F❌] Examples valid\n\nRecommended Updates:\n1. [Update type] - [Specific change needed]\n2. [Update type] - [Specific change needed]\n\nGenerate updates now? [Yes \u002F Skip \u002F Remind Later]\n```\n\n---\n\n## Documentation Templates\n\n### Function Documentation\n\n**TypeScript\u002FJavaScript:**\n```typescript\n\u002F**\n * Brief description of what the function does.\n *\n * Longer description if needed, explaining the context,\n * use cases, or important implementation details.\n *\n * @param paramName - Description of the parameter\n * @param optionalParam - Description (optional, defaults to X)\n * @returns Description of return value\n * @throws {ErrorType} When condition occurs\n *\n * @example\n * \u002F\u002F Basic usage\n * const result = functionName('value');\n *\n * @example\n * \u002F\u002F With options\n * const result = functionName('value', { option: true });\n *\n * @see relatedFunction\n * @since 1.2.0\n *\u002F\n```\n\n**Python:**\n```python\ndef function_name(param_name: str, optional_param: int = 0) -> ReturnType:\n    \"\"\"\n    Brief description of what the function does.\n\n    Longer description if needed, explaining the context,\n    use cases, or important implementation details.\n\n    Args:\n        param_name: Description of the parameter\n        optional_param: Description (defaults to 0)\n\n    Returns:\n        Description of return value\n\n    Raises:\n        ErrorType: When condition occurs\n\n    Example:\n        >>> result = function_name('value')\n        >>> print(result)\n\n    See Also:\n        related_function\n    \"\"\"\n```\n\n### API Endpoint Documentation\n\n```markdown\n## Endpoint Name\n\n`METHOD \u002Fpath\u002Fto\u002Fendpoint`\n\nBrief description of what the endpoint does.\n\n### Authentication\n\n[Required\u002FOptional] - [Auth type: Bearer, API Key, etc.]\n\n### Request\n\n#### Headers\n\n| Header | Required | Description |\n|--------|----------|-------------|\n| Authorization | Yes | Bearer token |\n| Content-Type | Yes | application\u002Fjson |\n\n#### Parameters\n\n| Parameter | Type | Required | Description |\n|-----------|------|----------|-------------|\n| id | string | Yes | Resource identifier |\n\n#### Body\n\n```json\n{\n  \"field\": \"value\",\n  \"nested\": {\n    \"field\": \"value\"\n  }\n}\n```\n\n### Response\n\n#### Success (200)\n\n```json\n{\n  \"data\": { ... },\n  \"meta\": { ... }\n}\n```\n\n#### Errors\n\n| Code | Description |\n|------|-------------|\n| 400 | Invalid request |\n| 401 | Unauthorized |\n| 404 | Resource not found |\n\n### Example\n\n```bash\ncurl -X POST https:\u002F\u002Fapi.example.com\u002Fpath \\\n  -H \"Authorization: Bearer token\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"field\": \"value\"}'\n```\n```\n\n---\n\n## Validation Protocol\n\n### Documentation Accuracy Check\n\n1. **Parameter Validation**\n   - All parameters documented\n   - Types match actual code\n   - Descriptions are accurate\n\n2. **Return Value Validation**\n   - Return type documented\n   - All possible returns covered\n   - Edge cases documented\n\n3. **Error Validation**\n   - All thrown errors documented\n   - Error conditions accurate\n   - Recovery guidance provided\n\n4. **Example Validation**\n   - Examples execute correctly\n   - Output matches documented output\n   - Edge cases demonstrated\n\n### Validation Report Format\n\n```\n✅ Documentation Validation Report\n\nFile: [path]\nStatus: [VALID \u002F WARNINGS \u002F INVALID]\n\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\nChecked Elements\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n| Function | Params | Returns | Errors | Examples |\n|----------|--------|---------|--------|----------|\n| auth() | ✅ | ✅ | ⚠️ | ✅ |\n| logout() | ✅ | ❌ | ✅ | ❌ |\n\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\nIssues Found\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n1. auth() - Missing @throws for RateLimitError\n2. logout() - Return type says void, but returns Promise\u003Cvoid>\n3. logout() - No example provided\n```\n\n---\n\n## Output Format\n\nAfter synchronization work:\n\n```\n📝 Documentation Sync Complete\n\nAction: [Detection \u002F Sync \u002F Validation]\nScope: [Files\u002Fmodules affected]\n\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\nResults\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\nStale Documentation: [N] files\nBroken References: [N] links\nMissing Documentation: [N] items\nUpdated: [N] files\n\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\nChanges Made\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n- [file.md] Updated function references\n- [source.ts] Added missing JSDoc\n\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\nRemaining Issues\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n- [issue requiring manual attention]\n```\n","You are a documentation synchronization specialist that ensures documentation stays current with code changes.\n\n## When to Activate\n\nActivate this skill when you need to:\n- **Detect stale documentation** that hasn't been updated with code changes\n- **Suggest documentation updates** during implementation\n- **Validate documentation accuracy** against current code\n- **Track documentation coverage** across the codebase\n- **Synchronize code comments** with external documentation\n\n## Core Principles\n\n### Documentation Should Be\n\n1. **Accurate** - Matches actual code behavior\n2. **Current** - Updated when code changes\n3. **Discoverable** - Easy to find and navigate\n4. **Actionable** - Helps users accomplish tasks\n5. **Minimal** - No more than necessary\n\n### Documentation Categories\n\n| Category | Location | Purpose | Update Trigger |\n|----------|----------|---------|----------------|\n| Inline | Source files | Function\u002Fclass docs | Code changes |\n| API | docs\u002Fapi\u002F | Endpoint reference | Route changes |\n| Architecture | docs\u002F | System design | Structural changes |\n| README | Root\u002Fmodule | Quick start | Setup changes |\n| Changelog | CHANGELOG.md | Version history | Releases |\n\n---\n\n## Staleness Detection\n\n### Detection Protocol\n\nRun these checks to identify stale documentation:\n\n#### 1. Git-based Staleness\n\nCompare documentation and code modification times:\n\n```bash\n# Find docs modified before related code\nfor doc in $(find docs -name \"*.md\"); do\n  doc_modified=$(git log -1 --format=\"%at\" -- \"$doc\" 2>\u002Fdev\u002Fnull || echo \"0\")\n  # Check related source files\n  related_source=$(echo \"$doc\" | sed 's\u002Fdocs\\\u002F\u002Fsrc\\\u002F\u002F; s\u002F\\.md$\u002F\u002F')\n  if [ -d \"$related_source\" ] || [ -f \"${related_source}.ts\" ]; then\n    source_modified=$(git log -1 --format=\"%at\" -- \"$related_source\"* 2>\u002Fdev\u002Fnull || echo \"0\")\n    if [ \"$source_modified\" -gt \"$doc_modified\" ]; then\n      echo \"STALE: $doc (doc: $(date -r $doc_modified), source: $(date -r $source_modified))\"\n    fi\n  fi\ndone\n```\n\n#### 2. Reference Validation\n\nCheck that documented items still exist:\n\n```bash\n# Extract function names from docs\ngrep -ohE '\\`[a-zA-Z_][a-zA-Z0-9_]*\\(\\)' docs\u002F*.md | \\\n  tr -d '`()' | \\\n  sort -u | \\\n  while read func; do\n    # Check if function exists in source\n    if ! grep -rq \"function $func\\|const $func\\|def $func\" src\u002F; then\n      echo \"BROKEN REF: $func in docs\"\n    fi\n  done\n```\n\n#### 3. Example Validation\n\nVerify code examples are syntactically correct:\n\n```bash\n# Extract code blocks and validate syntax\n# (Language-specific validation)\n```\n\n### Staleness Categories\n\n| Category | Threshold | Action |\n|----------|-----------|--------|\n| 🔴 Critical | Code changed, doc not updated | Immediate update |\n| 🟡 Warning | > 90 days since update | Review needed |\n| ⚪ Info | > 180 days since update | Consider refresh |\n\n---\n\n## Coverage Analysis\n\n### Metrics to Track\n\n| Metric | Formula | Target |\n|--------|---------|--------|\n| Function Coverage | Documented functions \u002F Total functions | > 80% |\n| Public API Coverage | Documented endpoints \u002F Total endpoints | 100% |\n| README Completeness | Sections present \u002F Required sections | 100% |\n| Example Coverage | Functions with examples \u002F Documented functions | > 50% |\n\n### Coverage Calculation\n\n```bash\n# Count total exported functions\ntotal_functions=$(grep -rE \"export (function|const|class)\" src\u002F | wc -l)\n\n# Count documented functions (with JSDoc\u002Fdocstring)\ndocumented=$(grep -rB1 \"export (function|const|class)\" src\u002F | grep -E \"\u002F\\*\\*|\\\"\\\"\\\"\" | wc -l)\n\n# Calculate coverage\ncoverage=$((documented * 100 \u002F total_functions))\necho \"Documentation coverage: ${coverage}%\"\n```\n\n### Coverage Report Format\n\n```\n📊 Documentation Coverage Report\n\nOverall Coverage: [N]%\n\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\nBy Category\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n| Category | Covered | Total | % |\n|----------|---------|-------|---|\n| Public Functions | [N] | [N] | [N]% |\n| Public Classes | [N] | [N] | [N]% |\n| API Endpoints | [N] | [N] | [N]% |\n| Configuration | [N] | [N] | [N]% |\n\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\nPriority Gaps (Public API)\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n1. src\u002Fapi\u002Fpayments.ts\n   - processPayment() - Missing docs\n   - refundPayment() - Missing docs\n\n2. src\u002Fapi\u002Fusers.ts\n   - createUser() - Incomplete (missing @throws)\n```\n\n---\n\n## Sync During Implementation\n\n### Implementation Hooks\n\nWhen code is modified, check documentation impact:\n\n#### Function Signature Changes\n\n```\n🔔 Documentation Sync Alert\n\nChange Detected: Function signature modified\nLocation: src\u002Fservices\u002Fauth.ts:authenticate()\n\nBefore: authenticate(email: string, password: string)\nAfter: authenticate(email: string, password: string, options?: AuthOptions)\n\nAffected Documentation:\n- docs\u002Fapi\u002Fauth.md (line 45) - Outdated signature\n- src\u002Fservices\u002Fauth.ts (JSDoc) - Missing @param options\n\nAction Required: Update documentation for new parameter\n```\n\n#### New Public API\n\n```\n🔔 Documentation Sync Alert\n\nNew Public API Detected:\n- src\u002Fapi\u002Fwebhooks.ts:handleStripeWebhook()\n\nNo documentation exists for this endpoint.\n\nSuggested Documentation:\n- Add to docs\u002Fapi\u002Fwebhooks.md\n- Add JSDoc in source file\n- Update API reference\n\nWould you like to generate documentation now?\n```\n\n#### Breaking Changes\n\n```\n🔔 Documentation Sync Alert\n\nBreaking Change Detected:\n- Removed: src\u002Fapi\u002Fusers.ts:getUser()\n- Now: src\u002Fapi\u002Fusers.ts:getUserById()\n\nDocumentation Impact:\n- docs\u002Fapi\u002Fusers.md references getUser() (3 occurrences)\n- README.md example uses getUser() (1 occurrence)\n\nAction Required:\n1. Update all references to getUserById()\n2. Add migration note to CHANGELOG.md\n3. Update code examples\n```\n\n### Sync Suggestion Format\n\nWhen suggesting documentation updates during implementation:\n\n```\n💡 Documentation Suggestion\n\nYou just modified: [file:function]\n\nCurrent Documentation Status:\n- [✅\u002F❌] JSDoc present\n- [✅\u002F❌] API docs current\n- [✅\u002F❌] Examples valid\n\nRecommended Updates:\n1. [Update type] - [Specific change needed]\n2. [Update type] - [Specific change needed]\n\nGenerate updates now? [Yes \u002F Skip \u002F Remind Later]\n```\n\n---\n\n## Documentation Templates\n\n### Function Documentation\n\n**TypeScript\u002FJavaScript:**\n```typescript\n\u002F**\n * Brief description of what the function does.\n *\n * Longer description if needed, explaining the context,\n * use cases, or important implementation details.\n *\n * @param paramName - Description of the parameter\n * @param optionalParam - Description (optional, defaults to X)\n * @returns Description of return value\n * @throws {ErrorType} When condition occurs\n *\n * @example\n * \u002F\u002F Basic usage\n * const result = functionName('value');\n *\n * @example\n * \u002F\u002F With options\n * const result = functionName('value', { option: true });\n *\n * @see relatedFunction\n * @since 1.2.0\n *\u002F\n```\n\n**Python:**\n```python\ndef function_name(param_name: str, optional_param: int = 0) -> ReturnType:\n    \"\"\"\n    Brief description of what the function does.\n\n    Longer description if needed, explaining the context,\n    use cases, or important implementation details.\n\n    Args:\n        param_name: Description of the parameter\n        optional_param: Description (defaults to 0)\n\n    Returns:\n        Description of return value\n\n    Raises:\n        ErrorType: When condition occurs\n\n    Example:\n        >>> result = function_name('value')\n        >>> print(result)\n\n    See Also:\n        related_function\n    \"\"\"\n```\n\n### API Endpoint Documentation\n\n```markdown\n## Endpoint Name\n\n`METHOD \u002Fpath\u002Fto\u002Fendpoint`\n\nBrief description of what the endpoint does.\n\n### Authentication\n\n[Required\u002FOptional] - [Auth type: Bearer, API Key, etc.]\n\n### Request\n\n#### Headers\n\n| Header | Required | Description |\n|--------|----------|-------------|\n| Authorization | Yes | Bearer token |\n| Content-Type | Yes | application\u002Fjson |\n\n#### Parameters\n\n| Parameter | Type | Required | Description |\n|-----------|------|----------|-------------|\n| id | string | Yes | Resource identifier |\n\n#### Body\n\n```json\n{\n  \"field\": \"value\",\n  \"nested\": {\n    \"field\": \"value\"\n  }\n}\n```\n\n### Response\n\n#### Success (200)\n\n```json\n{\n  \"data\": { ... },\n  \"meta\": { ... }\n}\n```\n\n#### Errors\n\n| Code | Description |\n|------|-------------|\n| 400 | Invalid request |\n| 401 | Unauthorized |\n| 404 | Resource not found |\n\n### Example\n\n```bash\ncurl -X POST https:\u002F\u002Fapi.example.com\u002Fpath \\\n  -H \"Authorization: Bearer token\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\"field\": \"value\"}'\n```\n```\n\n---\n\n## Validation Protocol\n\n### Documentation Accuracy Check\n\n1. **Parameter Validation**\n   - All parameters documented\n   - Types match actual code\n   - Descriptions are accurate\n\n2. **Return Value Validation**\n   - Return type documented\n   - All possible returns covered\n   - Edge cases documented\n\n3. **Error Validation**\n   - All thrown errors documented\n   - Error conditions accurate\n   - Recovery guidance provided\n\n4. **Example Validation**\n   - Examples execute correctly\n   - Output matches documented output\n   - Edge cases demonstrated\n\n### Validation Report Format\n\n```\n✅ Documentation Validation Report\n\nFile: [path]\nStatus: [VALID \u002F WARNINGS \u002F INVALID]\n\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\nChecked Elements\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n| Function | Params | Returns | Errors | Examples |\n|----------|--------|---------|--------|----------|\n| auth() | ✅ | ✅ | ⚠️ | ✅ |\n| logout() | ✅ | ❌ | ✅ | ❌ |\n\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\nIssues Found\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n1. auth() - Missing @throws for RateLimitError\n2. logout() - Return type says void, but returns Promise\u003Cvoid>\n3. logout() - No example provided\n```\n\n---\n\n## Output Format\n\nAfter synchronization work:\n\n```\n📝 Documentation Sync Complete\n\nAction: [Detection \u002F Sync \u002F Validation]\nScope: [Files\u002Fmodules affected]\n\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\nResults\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\nStale Documentation: [N] files\nBroken References: [N] links\nMissing Documentation: [N] items\nUpdated: [N] files\n\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\nChanges Made\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n- [file.md] Updated function references\n- [source.ts] Added missing JSDoc\n\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\nRemaining Issues\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n- [issue requiring manual attention]\n```\n",{"name":5,"description":7,"allowed-tools":49},"Read, Write, Edit, Grep, Glob, Bash","main","7850740bd837adb32f0a109ab2af82482196c6f2","skills\u002F_collections\u002Fplugins\u002Fstart\u002Fskills\u002Fdocumentation-sync",1,"https:\u002F\u002Fgithub.com\u002Fshengdabai\u002FTony-Claude-Code-Skills","https:\u002F\u002Fzturnsgo.com","https:\u002F\u002Fgithub.com\u002Fshengdabai","https:\u002F\u002Fzturnsgo.com\u002F","AI × education creator — producer, not consumer. Taught 6,000+ learners; shipping learning tools & daily essays with Claude Code, practicing @xiaolai's way 🥋","2026-11-01 21:28:23",{"source":8,"skillName":5,"commands":61,"prompt":71,"zipAvailable":72},[62,65,68],{"tool":63,"command":64},"npx","npx skills add shengdabai\u002FTony-Claude-Code-Skills --skill documentation-sync",{"tool":66,"command":67},"bunx","bunx skills add shengdabai\u002FTony-Claude-Code-Skills --skill documentation-sync",{"tool":69,"command":70},"pnpm","pnpm dlx skills add shengdabai\u002FTony-Claude-Code-Skills --skill documentation-sync","安装技能，技能地址：https:\u002F\u002Fgithub.com\u002Fshengdabai\u002FTony-Claude-Code-Skills\u002Fblob\u002Fmain\u002Fskills\u002F_collections\u002Fplugins\u002Fstart\u002Fskills\u002Fdocumentation-sync\u002FSKILL.md",true,[],[75,94,122,148,169,188],{"skillNo":76,"name":77,"nameZh":6,"description":78,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":79,"categories":80,"keywords":86,"publishedAt":44},"01M70P17DAD4C1C47NPH6A96EM","xiaolai-methodology","以李笑来(Li Xiaolai)的思考方式、方法论与表达风格,为用户做全方位 1-on-1 教练指导,覆盖创业、赚钱、投资、学习、自学、读书写作、用 AI、以及人生心态与自我管理。当用户提到 \"李笑来\"、\"笑来\"、\"笑来老师\"、\"扮演李笑来\"、\"找笑来聊聊\"、\"笑来怎么看\"、\"xiaolai\"、\"把时间当作朋友\"、\"通往财富自由之路\"、\"定投改变命运\"、\"韭菜的自我修养\"、\"自学是门手艺\"、\"让时间陪你慢慢变富\"、\"七年就是一辈子\"、\"元认知\"、\"活在未来\"、\"复利\u002F长期主义\"、\"践行\"、\"痴迷改进\"、\"个人商业模式\u002F出售时间\"、\"睡后收入\"、\"定投\"、\"财富自由\"、\"操作系统升级\"、\"最少必要知识\"、\"北极星提示词\"、\"用 AI 该怎么学\u002F思考\" 等任一触发词,或当用户带着关于创业\u002F赚钱\u002F投资\u002F学习\u002F职业\u002F重大人生决策的困惑、希望被人用笑来式的「逻辑 + 大白话 + 类比 + 重新定义 + 践行导向」来点醒和指导时,自动进入李笑来教练模式。","https:\u002F\u002Fgithub.com\u002Fshengdabai\u002FTony-Claude-Code-Skills\u002Fblob\u002Fmain\u002Fxiaolai-methodology\u002FSKILL.md",[81],{"categoryNo":82,"categoryName":83,"taxonomyType":84,"taxonomyTypeDesc":85},"01JBSEEDCAT000000000000018","写作与文案","SCENARIO","使用场景",[87,88,89,90,91,92,93],"methodology","xiaolai","xiaolai methodology","朋友","投资","writing","收入",{"skillNo":95,"name":96,"nameZh":6,"description":97,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":98,"categories":99,"keywords":104,"publishedAt":44},"01M70P13NB9YP7ACJR1S861CDS","zread","Produce and consume a wiki-style knowledge base for a code repository via the `zread` CLI and its on-disk output under `.\u002F.zread\u002Fwiki\u002F`. Use this skill whenever the user wants to understand, onboard onto, explore, summarize, map, or get an overview of an unfamiliar codebase; asks for architecture docs, a project wiki, a repo walkthrough, module\u002Fpackage explanations, or \"what does this repo do\"; wants to generate, regenerate, resume, browse, or serve code documentation locally; or mentions zread \u002F zread.ai directly. Also use it proactively before diving into a large unknown repo — if `.\u002F.zread\u002Fwiki\u002Fcurrent` exists, read the generated pages instead of crawling source file-by-file; if it doesn't, consider offering to run `zread generate`. The trigger is the intent (understand a codebase through generated docs), not the literal word \"zread\".","https:\u002F\u002Fgithub.com\u002Fshengdabai\u002FTony-Claude-Code-Skills\u002Fblob\u002Fmain\u002Fskills\u002Fzread\u002FSKILL.md",[100,103],{"categoryNo":101,"categoryName":102,"taxonomyType":84,"taxonomyTypeDesc":85},"01JBSEEDCAT000000000000023","Skill与智能体开发",{"categoryNo":19,"categoryName":20,"taxonomyType":21,"taxonomyTypeDesc":22},[96,105,106,107,108,109,110,111,112,113,114,115,116,24,117,118,119,34,120,121],"knowledge","wiki","explore","walkthrough","project","get","knowledge base","run","generate","intent","cli","map","project wiki","disk","architecture","unknown","generated",{"skillNo":123,"name":124,"nameZh":6,"description":125,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":126,"categories":127,"keywords":132,"publishedAt":44},"01M70P10S4SWMZQ8BJAFBFDRW3","youtube","Launch the YouTube Creator Agent to auto-generate videos.\nUse when: user types \u002Fyoutube, wants to create YouTube videos,\ngenerate video content, or upload to YouTube.\nKeywords: youtube, video, 视频, 创作视频, 发布视频","https:\u002F\u002Fgithub.com\u002Fshengdabai\u002FTony-Claude-Code-Skills\u002Fblob\u002Fmain\u002Fskills\u002Fyoutube\u002FSKILL.md",[128,129],{"categoryNo":101,"categoryName":102,"taxonomyType":84,"taxonomyTypeDesc":85},{"categoryNo":130,"categoryName":131,"taxonomyType":21,"taxonomyTypeDesc":22},"01JBSEEDCAT000000000000036","内容创作者",[124,133,134,135,136,137,138,139,113,140,141,142,39,143,144,145,146,147],"user","content","视频","creator","generate video","videos","launch","video content","create","upload","use","auto","types","Video","创作",{"skillNo":149,"name":150,"nameZh":6,"description":151,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":152,"categories":153,"keywords":155,"publishedAt":44},"01M70P0YE95D8BACZCGV8BK90K","youtube-script-sync","Sync, update, or optimize Tony's GetNote knowledge base `Youtube视频逐字稿` by turning each parent recording or first-person idea note into an idempotent child note containing a directly recordable YouTube long-video or Shorts script. Use when the user says “更新\u002F同步\u002F优化 Youtube视频逐字稿知识库”, or says “更新\u002F同步\u002F优化该知识库” while this knowledge base is the active context.","https:\u002F\u002Fgithub.com\u002Fshengdabai\u002FTony-Claude-Code-Skills\u002Fblob\u002Fmain\u002Fskills\u002Fyoutube-script-sync\u002FSKILL.md",[154],{"categoryNo":101,"categoryName":102,"taxonomyType":84,"taxonomyTypeDesc":85},[25,156,124,157,158,146,159,160,161,162,163,164,165,166,111,167,39,143,105,168],"script","youtube script sync","recording","shorts","first","base","person","update","active","child","optimize","idempotent","long",{"skillNo":170,"name":171,"nameZh":6,"description":172,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":173,"categories":174,"keywords":179,"publishedAt":44},"01M70P0WMV5XT0EEC0N445PW07","writing-skills","How to write SKILL.md files that trigger reliably and teach effectively. Use when creating, improving, or reviewing Claude Code skills.","https:\u002F\u002Fgithub.com\u002Fshengdabai\u002FTony-Claude-Code-Skills\u002Fblob\u002Fmain\u002Fskills\u002Fxiaolai\u002Fnlpm\u002Fskills\u002Fnlpm\u002Fwriting-skills\u002FSKILL.md",[175,176,177,178],{"categoryNo":82,"categoryName":83,"taxonomyType":84,"taxonomyTypeDesc":85},{"categoryNo":101,"categoryName":102,"taxonomyType":84,"taxonomyTypeDesc":85},{"categoryNo":19,"categoryName":20,"taxonomyType":21,"taxonomyTypeDesc":22},{"categoryNo":130,"categoryName":131,"taxonomyType":21,"taxonomyTypeDesc":22},[180,92,181,182,183,30,34,39,143,184,185,186,187],"writing skills","how","teach","write skill","claude code skills","files","how to","trigger",{"skillNo":189,"name":190,"nameZh":6,"description":191,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":192,"categories":193,"keywords":196,"publishedAt":44},"01M70P0SJFR4YVJQBGMHKGSKXT","writing-rules","How to write .claude\u002Frules\u002F files that Claude actually follows. Use when creating, improving, or reviewing project rules.","https:\u002F\u002Fgithub.com\u002Fshengdabai\u002FTony-Claude-Code-Skills\u002Fblob\u002Fmain\u002Fskills\u002Fxiaolai\u002Fnlpm\u002Fskills\u002Fnlpm\u002Fwriting-rules\u002FSKILL.md",[194,195],{"categoryNo":82,"categoryName":83,"taxonomyType":84,"taxonomyTypeDesc":85},{"categoryNo":130,"categoryName":131,"taxonomyType":21,"taxonomyTypeDesc":22},[197,92,198,109,199,185,39,181,30,143,186],"Rules","writing rules","project rules"]