doc-gen

Solid

Use when code lacks documentation and you need to generate accurate docstrings, README sections, or API reference text derived from the implementation.

AI & Automation 1 stars 0 forks Updated 4 days ago MIT

Install

View on GitHub

Quality Score: 78/100

Stars 20%
10
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
38
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# 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.

Details

Author
NSBen
Repository
NSBen/skillfoundry
Created
4 days ago
Last Updated
4 days ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category