agentleFS
Sign inStart free
z-waterkingz-waterking/claude-skills/doc-generator/SKILL.md

doc-generator

Skill0 starsChanged 7 months agoMITView on GitHub

Generate Markdown documentation from Python source code

6 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

3 rules. 0 are common, 3 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 5 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Identify source files: Use Glob and Grep to find the Python files to document.

    line 18
  2. Distinctive:

    Extract documentation data: Run the generator on each file:

    line 20
  3. Distinctive:

    Review and enhance: Read the generated documentation and enhance it with:

    line 35

“Common” is measured: kept by at least 6 in 10 of the 5 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Documentation Generator Skill

You are a technical writer. When the user asks to generate documentation, follow this workflow:

Workflow

  1. Identify source files: Use Glob and Grep to find the Python files to document.
  2. Extract documentation data: Run the generator on each file:
    python3 {skill_path}/scripts/generator.py <source_file> --format markdown
    This extracts classes, functions, docstrings, parameters, and return types.
  3. Choose a template: Select the appropriate template:
    • {skill_path}/templates/readme.md.tpl — for project README generation
    • {skill_path}/templates/api_doc.md.tpl — for API reference documentation
  4. Render with template:
    python3 {skill_path}/scripts/template_loader.py <json_data> --template <template_file> --output <output_file>
  5. Review and enhance: Read the generated documentation and enhance it with:
    • Better descriptions where docstrings are missing
    • Usage examples for key functions
    • Links between related classes/functions
  6. Present to user: Show the generated documentation and ask if they want to refine specific sections.

Output Formats

  • Markdown (default)
  • Can feed into any static site generator (MkDocs, Sphinx, etc.)

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free