{"id":"76ccebe2-96a1-4f89-81dc-1932e107b970","shortId":"763nw2","kind":"skill","title":"generating-docs","tagline":"Generates README.md and DESIGN.md scaffolds by analyzing module structure. Use when creating documentation templates for new modules. Automatically triggered at module creation.","description":"# 造典关卡 · 文档生成器\n\n## 命令\n\n```bash\nnode scripts/doc_generator.js <模块路径>\nnode scripts/doc_generator.js <模块路径> --force  # 强制覆盖\nnode scripts/doc_generator.js <模块路径> --json   # JSON\n```\n\n## 生成内容\n\n| 文件 | 内容 |\n|------|------|\n| README.md | 模块名(取自目录)、描述(docstring)、特性、依赖、使用方法、API 概览、目录结构 |\n| DESIGN.md | 设计目标/非目标、架构、核心组件(取自代码)、决策表、技术选型、权衡、安全考量 |\n\n## 语言支持\n\nPython：类、函数、docstring、依赖 | Go/TS/Rust：目录结构、依赖 | 其他：基础目录结构\n\n## 触发条件\n\n新建模块 | 检测到缺失文档\n\n## 流程\n\n```\ndoc_generator.js 生成 → 填充 TODO → 补决策理由 → 加示例 → /verify-module 校验\n```\n\n## 生成后检查\n\nREADME：描述、特性、示例、依赖齐备\nDESIGN：目标、决策理由、选型、已知限制齐备","tags":["generating","docs","code","abyss","telagod","agent-skills","ai-agent","ai-assistant","ai-personality","blue-team","character-card","claude-code"],"capabilities":["skill","source-telagod","skill-generating-docs","topic-agent-skills","topic-ai-agent","topic-ai-assistant","topic-ai-personality","topic-blue-team","topic-character-card","topic-claude-code","topic-cli","topic-codex","topic-codex-cli","topic-configuration","topic-developer-tools"],"categories":["code-abyss"],"synonyms":[],"warnings":[],"endpointUrl":"https://skills.sh/telagod/code-abyss/generating-docs","protocol":"skill","transport":"skills-sh","auth":{"type":"none","details":{"cli":"npx skills add telagod/code-abyss","source_repo":"https://github.com/telagod/code-abyss","install_from":"skills.sh"}},"qualityScore":"0.555","qualityRationale":"deterministic score 0.56 from registry signals: · indexed on github topic:agent-skills · 211 github stars · SKILL.md body (564 chars)","verified":false,"liveness":"unknown","lastLivenessCheck":null,"agentReviews":{"count":0,"score_avg":null,"cost_usd_avg":null,"success_rate":null,"latency_p50_ms":null,"narrative_summary":null,"summary_updated_at":null},"enrichmentModel":"deterministic:skill-github:v1","enrichmentVersion":1,"enrichedAt":"2026-05-18T18:55:06.424Z","embedding":null,"createdAt":"2026-05-16T12:54:50.532Z","updatedAt":"2026-05-18T18:55:06.424Z","lastSeenAt":"2026-05-18T18:55:06.424Z","tsv":"'/verify-module':88 'analyz':10 'api':54 'automat':21 'bash':29 'creat':15 'creation':25 'design':96 'design.md':7,57 'doc':3 'doc_generator.js':82 'docstr':50,71 'document':16 'forc':36 'generat':2,4 'generating-doc':1 'go/ts/rust':73 'json':41,42 'modul':11,20,24 'new':19 'node':30,33,38 'python':68 'readm':91 'readme.md':5,46 'scaffold':8 'scripts/doc_generator.js':31,34,39 'skill' 'skill-generating-docs' 'source-telagod' 'structur':12 'templat':17 'todo':85 'topic-agent-skills' 'topic-ai-agent' 'topic-ai-assistant' 'topic-ai-personality' 'topic-blue-team' 'topic-character-card' 'topic-claude-code' 'topic-cli' 'topic-codex' 'topic-codex-cli' 'topic-configuration' 'topic-developer-tools' 'trigger':22 'use':13 '使用方法':53 '依赖':52,72,75 '依赖齐备':95 '其他':76 '内容':45 '决策理由':98 '决策表':63 '函数':70 '加示例':87 '取自代码':62 '取自目录':48 '命令':28 '基础目录结构':77 '填充':84 '安全考量':66 '已知限制齐备':100 '强制覆盖':37 '技术选型':64 '描述':49,92 '文件':44 '文档生成器':27 '新建模块':79 '权衡':65 '架构':60 '校验':89 '核心组件':61 '检测到缺失文档':80 '概览':55 '模块名':47 '模块路径':32,35,40 '流程':81 '特性':51,93 '生成':83 '生成内容':43 '生成后检查':90 '目录结构':56,74 '目标':97 '示例':94 '类':69 '补决策理由':86 '触发条件':78 '设计目标':58 '语言支持':67 '选型':99 '造典关卡':26 '非目标':59","prices":[{"id":"e62395dc-35a6-4c02-a08b-fc67b9ad21b4","listingId":"76ccebe2-96a1-4f89-81dc-1932e107b970","amountUsd":"0","unit":"free","nativeCurrency":null,"nativeAmount":null,"chain":null,"payTo":null,"paymentMethod":"skill-free","isPrimary":true,"details":{"org":"telagod","category":"code-abyss","install_from":"skills.sh"},"createdAt":"2026-05-16T12:54:50.532Z"}],"sources":[{"listingId":"76ccebe2-96a1-4f89-81dc-1932e107b970","source":"github","sourceId":"telagod/code-abyss/generating-docs","sourceUrl":"https://github.com/telagod/code-abyss/tree/main/skills/generating-docs","isPrimary":false,"firstSeenAt":"2026-05-16T12:54:50.532Z","lastSeenAt":"2026-05-18T18:55:06.424Z"}],"details":{"listingId":"76ccebe2-96a1-4f89-81dc-1932e107b970","quickStartSnippet":null,"exampleRequest":null,"exampleResponse":null,"schema":null,"openapiUrl":null,"agentsTxtUrl":null,"citations":[],"useCases":[],"bestFor":[],"notFor":[],"kindDetails":{"org":"telagod","slug":"generating-docs","github":{"repo":"telagod/code-abyss","stars":211,"topics":["agent-skills","ai-agent","ai-assistant","ai-personality","blue-team","character-card","claude-code","cli","codex","codex-cli","configuration","developer-tools","devops","gemini-cli","persona","prompt-engineering","red-team","security","skills"],"license":"mit","html_url":"https://github.com/telagod/code-abyss","pushed_at":"2026-05-16T10:42:04Z","description":"Give your AI coding agent a personality. Composable persona + style + skills for Claude Code, Codex, Gemini CLI & OpenClaw. Ships Tech Persona Card v1.0 spec.","skill_md_sha":"0a106ecb68d6e52672d36f13c665ea1f0d5b05d8","skill_md_path":"skills/generating-docs/SKILL.md","default_branch":"main","skill_tree_url":"https://github.com/telagod/code-abyss/tree/main/skills/generating-docs"},"layout":"multi","source":"github","category":"code-abyss","frontmatter":{"name":"generating-docs","description":"Generates README.md and DESIGN.md scaffolds by analyzing module structure. Use when creating documentation templates for new modules. Automatically triggered at module creation.","compatibility":"node>=18"},"skills_sh_url":"https://skills.sh/telagod/code-abyss/generating-docs"},"updatedAt":"2026-05-18T18:55:06.424Z"}}