{"id":"c159dc0b-f2ea-4ab9-b598-c1dc152614ac","shortId":"3HcvyB","kind":"skill","title":"code-docs","tagline":"Documentation generation for code projects. Use when updating docs, writing README, generating API docs, creating changelog, or when the user mentions documentation, docs, readme, api docs, or any documentation task.","description":"# Code Docs\n\nDocumentation generation and maintenance for code projects.\n\n## When to Document\n\n**Always update docs when:**\n- Adding new features\n- Changing existing behavior\n- Updating configuration\n- Breaking changes\n\n**Docs should live:**\n- Near the code (docstrings, comments)\n- In the repo (README, docs folder)\n- Generated (API docs, type docs)\n\n---\n\n## Doc Types\n\n### README\n\nProject overview, setup, usage. See references/readme-structure.md\n\n**Template:**\n```markdown\n# Project Name\n\nBrief description (one line).\n\n## Quick Start\n\n3-5 commands to get running.\n\n## Installation\n\nDetailed setup steps.\n\n## Usage\n\nCode examples.\n\n## API\n\nLink to full API docs.\n\n## Contributing\n\nHow to contribute.\n\n## License\n```\n\n### API Documentation\n\nSee references/api-docs.md for:\n- TypeDoc (JavaScript/TypeScript)\n- Sphinx (Python)\n- godoc (Go)\n- JSDoc (JavaScript)\n\n### Changelog\n\nSee references/changelog.md for Keep a Changelog format.\n\n**Sections:**\n- Added\n- Changed\n- Deprecated\n- Removed\n- Fixed\n- Security\n\n### Architecture Docs\n\nSee references/architecture-docs.md for:\n- ADRs (Architecture Decision Records)\n- Diagrams\n- System overviews\n\n---\n\n## Generation Commands\n\n### TypeScript/JavaScript\n\n```bash\n# TypeDoc\nnpx typedoc --out docs src/index.ts\n\n# JSDoc\nnpx jsdoc src/ -d docs/\n\n# API Extractor (monorepos)\nnpx api-extractor run\n```\n\n### Python\n\n```bash\n# Sphinx\nsphinx-build -b html docs docs/_build\n\n# pdoc\npdoc --output-dir docs src/\n\n# mkdocs\nmkdocs serve\n```\n\n### Go\n\n```bash\n# godoc\ngodoc -http=:6060\n\n# swag (OpenAPI from comments)\nswag init -g cmd/server/main.go\n```\n\n---\n\n## Workflow\n\n### 1. Identify what needs docs\n\n- New files/features → update relevant doc\n- Breaking change → update CHANGELOG\n- New public API → update API docs\n\n### 2. Generate/Update\n\n- Run doc generators\n- Update manual docs\n- Verify examples work\n\n### 3. Verify\n\n- Links work\n- Examples run\n- Build passes\n\n### 4. Commit\n\n```\ndocs: update API documentation\n\nGenerated via typedoc.\nAdded: new /users endpoint\nChanged: authentication section\n```\n\n---\n\n## Best Practices\n\n1. **Write docs in the code** - Docstrings, comments\n2. **Generate where possible** - Don't duplicate\n3. **Keep README minimal** - Link to detailed docs\n4. **Version with code** - Docs in same repo/PR\n5. **Test examples** - Ensure they run","tags":["code","docs","atelier","martinffx","agent-skills","agentic-coding","anthropic","claude-code","claude-skills","code-review","codex","codex-skill"],"capabilities":["skill","source-martinffx","skill-code-docs","topic-agent-skills","topic-agentic-coding","topic-anthropic","topic-claude-code","topic-claude-skills","topic-code-review","topic-codex","topic-codex-skill","topic-opencode","topic-prompt-engineering","topic-sdd","topic-spec-driven-development"],"categories":["atelier"],"synonyms":[],"warnings":[],"endpointUrl":"https://skills.sh/martinffx/atelier/code-docs","protocol":"skill","transport":"skills-sh","auth":{"type":"none","details":{"cli":"npx skills add martinffx/atelier","source_repo":"https://github.com/martinffx/atelier","install_from":"skills.sh"}},"qualityScore":"0.461","qualityRationale":"deterministic score 0.46 from registry signals: · indexed on github topic:agent-skills · 23 github stars · SKILL.md body (2,303 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-18T19:05:21.945Z","embedding":null,"createdAt":"2026-05-10T07:03:10.965Z","updatedAt":"2026-05-18T19:05:21.945Z","lastSeenAt":"2026-05-18T19:05:21.945Z","tsv":"'-5':99 '/users':271 '1':221,278 '2':241,286 '3':98,252,293 '4':260,301 '5':309 '6060':211 'ad':50,144,269 'adr':155 'alway':46 'api':16,28,75,111,115,122,178,183,237,239,264 'api-extractor':182 'architectur':150,156 'authent':274 'b':192 'bash':165,187,207 'behavior':55 'best':276 'break':58,231 'brief':92 'build':191,258 'chang':53,59,145,232,273 'changelog':19,135,141,234 'cmd/server/main.go':219 'code':2,7,34,41,65,109,283,304 'code-doc':1 'command':100,163 'comment':67,215,285 'commit':261 'configur':57 'contribut':117,120 'creat':18 'd':176 'decis':157 'deprec':146 'descript':93 'detail':105,299 'diagram':159 'dir':200 'doc':3,12,17,26,29,35,48,60,72,76,78,79,116,151,170,177,194,201,225,230,240,244,248,262,280,300,305 'docs/_build':195 'docstr':66,284 'document':4,25,32,36,45,123,265 'duplic':292 'endpoint':272 'ensur':312 'exampl':110,250,256,311 'exist':54 'extractor':179,184 'featur':52 'files/features':227 'fix':148 'folder':73 'format':142 'full':114 'g':218 'generat':5,15,37,74,162,245,266,287 'generate/update':242 'get':102 'go':132,206 'godoc':131,208,209 'html':193 'http':210 'identifi':222 'init':217 'instal':104 'javascript':134 'javascript/typescript':128 'jsdoc':133,172,174 'keep':139,294 'licens':121 'line':95 'link':112,254,297 'live':62 'mainten':39 'manual':247 'markdown':89 'mention':24 'minim':296 'mkdoc':203,204 'monorepo':180 'name':91 'near':63 'need':224 'new':51,226,235,270 'npx':167,173,181 'one':94 'openapi':213 'output':199 'output-dir':198 'overview':83,161 'pass':259 'pdoc':196,197 'possibl':289 'practic':277 'project':8,42,82,90 'public':236 'python':130,186 'quick':96 'readm':14,27,71,81,295 'record':158 'references/api-docs.md':125 'references/architecture-docs.md':153 'references/changelog.md':137 'references/readme-structure.md':87 'relev':229 'remov':147 'repo':70 'repo/pr':308 'run':103,185,243,257,314 'section':143,275 'secur':149 'see':86,124,136,152 'serv':205 'setup':84,106 'skill' 'skill-code-docs' 'source-martinffx' 'sphinx':129,188,190 'sphinx-build':189 'src':175,202 'src/index.ts':171 'start':97 'step':107 'swag':212,216 'system':160 'task':33 'templat':88 'test':310 'topic-agent-skills' 'topic-agentic-coding' 'topic-anthropic' 'topic-claude-code' 'topic-claude-skills' 'topic-code-review' 'topic-codex' 'topic-codex-skill' 'topic-opencode' 'topic-prompt-engineering' 'topic-sdd' 'topic-spec-driven-development' 'type':77,80 'typedoc':127,166,168,268 'typescript/javascript':164 'updat':11,47,56,228,233,238,246,263 'usag':85,108 'use':9 'user':23 'verifi':249,253 'version':302 'via':267 'work':251,255 'workflow':220 'write':13,279","prices":[{"id":"c07a018e-978a-48ce-b894-bf8014b00877","listingId":"c159dc0b-f2ea-4ab9-b598-c1dc152614ac","amountUsd":"0","unit":"free","nativeCurrency":null,"nativeAmount":null,"chain":null,"payTo":null,"paymentMethod":"skill-free","isPrimary":true,"details":{"org":"martinffx","category":"atelier","install_from":"skills.sh"},"createdAt":"2026-05-10T07:03:10.965Z"}],"sources":[{"listingId":"c159dc0b-f2ea-4ab9-b598-c1dc152614ac","source":"github","sourceId":"martinffx/atelier/code-docs","sourceUrl":"https://github.com/martinffx/atelier/tree/main/skills/code-docs","isPrimary":false,"firstSeenAt":"2026-05-10T07:03:10.965Z","lastSeenAt":"2026-05-18T19:05:21.945Z"}],"details":{"listingId":"c159dc0b-f2ea-4ab9-b598-c1dc152614ac","quickStartSnippet":null,"exampleRequest":null,"exampleResponse":null,"schema":null,"openapiUrl":null,"agentsTxtUrl":null,"citations":[],"useCases":[],"bestFor":[],"notFor":[],"kindDetails":{"org":"martinffx","slug":"code-docs","github":{"repo":"martinffx/atelier","stars":23,"topics":["agent-skills","agentic-coding","anthropic","claude-code","claude-skills","code-review","codex","codex-skill","opencode","prompt-engineering","sdd","spec-driven-development"],"license":"mit","html_url":"https://github.com/martinffx/atelier","pushed_at":"2026-05-18T06:56:45Z","description":"An atelier for Opencode, Claude Code, and other coding agents: spec-driven workflows, deep thinking, and code quality.","skill_md_sha":"021981b030a3720375a7d7020fac65e7a8f00105","skill_md_path":"skills/code-docs/SKILL.md","default_branch":"main","skill_tree_url":"https://github.com/martinffx/atelier/tree/main/skills/code-docs"},"layout":"multi","source":"github","category":"atelier","frontmatter":{"name":"code-docs","description":"Documentation generation for code projects. Use when updating docs, writing README, generating API docs, creating changelog, or when the user mentions documentation, docs, readme, api docs, or any documentation task."},"skills_sh_url":"https://skills.sh/martinffx/atelier/code-docs"},"updatedAt":"2026-05-18T19:05:21.945Z"}}