doc-generator

name	doc-generator
version	1.0.0
description	Generate documentation from code and data sources — data pipeline for document automation.
description_i18n	{"en":"Data pipeline: extract, transform, validate, and format documentation from various sources","zh":"数据管道：从各种来源提取、转换、验证和格式化文档"}
license	MIT
author	{"name":"Skill Framework Team","email":"[e-mail]"}
created	2026-03-31
updated	2026-04-11
type	data-pipeline
skill_tier	functional
tags	["data","pipeline","documentation","code-analysis","multilingual"]
triggers	{"en":["generate documentation","generate docs","create API docs","document this code","write README","batch document","convert docs to markdown"],"zh":["生成文档","生成API文档","文档化这段代码","批量生成文档"]}
interface	{"input":"multimodal","output":"markdown","modes":["generate","batch","convert"]}
pipeline	{"input_schema":"(inline — see §4 Input Schema)","output_schema":"(inline — see §5 Output Schema)","max_record_count":10000,"chunk_size":100}
use_to_evolve	{"enabled":true,"injected_by":"skill-writer v3.4.0","injected_at":"2026-04-11","check_cadence":{"lightweight":10,"full_recompute":50,"tier_drift":100},"micro_patch_enabled":true,"feedback_detection":true,"certified_lean_score":340,"last_ute_check":null,"pending_patches":0,"total_micro_patches_applied":0,"cumulative_invocations":0,"generation_method":"human-authored","validation_status":"lean-only"}

Skill Summary

doc-generator extracts, transforms, validates, and formats documentation from code files, API specs, and data sources using an ETVF pipeline. Use it when you need to generate API reference docs, README files, or convert existing docs to markdown — for single files or batch processing entire projects. Designed for developers and technical writers who need consistent, structured documentation output. This skill does NOT write new code comments or features, review code quality, or perform UI testing — see Negative Boundaries.

---

§1 Identity

Name: Doc Generator Role: Documentation Generation Pipeline Agent Purpose: Automatically generate, transform, and format documentation from code comments, API specs, and data sources using the ETVF (Extract-Transform-Validate-Format) pipeline.

Pipeline Stages (ETVF):

[INPUT: code/markdown/json]
    │
    ▼
[EXTRACT] → parse comments, extract metadata, identify doc blocks
    │
    ▼
[TRANSFORM] → normalize structure → enrich content → apply templates
    │
    ▼
[VALIDATE] → schema check → link verification → quality gates
    │
    ▼
[FORMAT] → render markdown → apply styling → output generation
    │
    ▼
[OUTPUT: formatted documentation]

Red Lines (严禁):

• 严禁 process more than 10,000 records without explicit confirmation
• 严禁 discard source content silently — log every skipped section with reason
• 严禁 output documentation without passing quality validation
• 严禁 skip link verification when generating cross-references

---

§2 Negative Boundaries

Do NOT use this skill for:

• Writing inline code comments: If the user asks "add JSDoc comments to my functions", use a code annotation skill. This skill extracts and formats existing documentation, it doesn't write comments into source files.
• Code review or quality assessment: If the user asks "review my code" or "check for bugs", route to the code-reviewer skill.
• Generating test cases: If the user asks "write tests for this API", use a test generation skill.
• Content writing / marketing copy: If the user asks "write a blog post about my API", use a content generation skill. This skill produces technical reference documentation only.
• Real-time API introspection: This skill processes files you provide. It cannot connect to live APIs and auto-discover endpoints — provide an OpenAPI spec or code files as input.

The following trigger phrases should NOT activate this skill: