← ClaudeAtlas

doc-genlisted

Use when code lacks documentation and you need to generate accurate docstrings, README sections, or API reference text derived from the implementation.
NSBen/skillfoundry · ★ 1 · AI & Automation · score 73
Install: claude install-skill NSBen/skillfoundry
# Doc Gen ## When to use Invoke this skill when public APIs, modules, or CLIs are undocumented or the docs are out of date. ## Steps 1. Read the signatures and the actual behaviour; never document intent you have not verified. 2. Write docstrings that state what the function does, its params, returns, and raises. 3. For READMEs, lead with what it is, a quickstart, and a clear example. 4. For API reference, keep one entry per public symbol, grouped by module. 5. Flag anything you could not determine instead of inventing details. ## Examples - "Generate docstrings for the payments module" - "Write a README quickstart from this CLI" ## References Match the project's existing doc style and dialect; link to source rather than duplicating long explanations.