docs-codebase

用途：在软件仓库中编写、重构与合并 docs-as-code 文档，覆盖 README、onboarding、runbook、API 参考、changelog、contributing、ADR 与 agent 指令文件，并支持对混乱 docs/ 目录做重整。\n\n主要能力：提供多类模板（README、ADR、gap analysis、API 参考、changelog、contributing、runbook、docs 结构、ownership 模型、doc sync checklist），以及 CI 资产：markdownlint 配置、Vale prose 配置、GitHub Actions docs-quality 工作流、internal link-check 配置（内链阻断、外链提示）。默认原则包括一主题一权威文档、按 Diátaxis 区分页面类型、在新建 Markdown 前通过 Markdown Creation Gate、文档与代码同周期更新、以 git 历史衡量新鲜度。提供 Revamp 模式用于清理重叠或 LLM 生成文档。\n\n使用方式：先判定文档类型与读者，检查仓库现有约定与权威文档，通过创建门禁后才从 assets/ 选模板；合并重复页，补 owner 与评审节奏，交付前跑文档 QA 与完整性检查。修改随附 CI 资产后，可在此技能目录运行 python3 -m pytest scripts/test_docs_quality.py（静态模板契约检查）。\n\n适用与限制：适合编写或清理技术文档；若任务是对文档做新鲜度或覆盖率审计、决定 PRD 与需求，则应改用其他技能。文档中未提供具体收费、平台或效果信息。