Documentation Generator

Trust Score 88/100

from code-abyss218

Generates README.md and DESIGN.md scaffolds from a module's code and structure to accelerate project documentation.

triggers:generate docsdoc generatormissing documentationmodule creationREADME scaffoldDESIGN scaffold

GitHub SKILL.md

What it does

Generates scaffolded README.md and DESIGN.md files by analyzing a module's directory, code, and docstrings. The tool extracts names, descriptions, features, dependencies, usage examples and architecture notes, producing a starting point that developers can refine. It supports multiple languages (Python, Go, TypeScript, Rust) and outputs a checklist for post-generation verification.

When to use it

Use when creating a new module with missing documentation, when onboarding contributors who need quick module overviews, or as part of a CI step that detects absent docs. It is triggered on module creation or when missing docs are detected.

What's included

Scripts: doc_generator.js script under the repo's scripts/ (has_scripts=true).
References: none provided in this repo's skill (has_references=false).
Instructions: run node scripts/doc_generator.js <module-path> with optional --force to overwrite or --json for machine output. The SKILL.md describes the generation flow and post-checklist (README: description, features, examples; DESIGN: goals, decisions, tradeoffs).

Compatible agents

Best suited for agent environments that can run Node.js scripts and inspect repository files (OpenClaw, Codex/CLI-style agents, Claude Code), and useful as a CI/automation utility for developer-focused assistants.

Audit Summary

Documentation generator skill that analyzes module structure and produces README.md and DESIGN.md scaffolds. Supports Python (with docstring/class/function extraction) and generic regex-based analysis for Go, Rust, TypeScript, JavaScript, Java, C, C++. The bundled script (doc_generator.js) was skipped during execution due to .js extension not being in the runner's allowed list. Code is well-structured with clear separation of concerns, proper .gitignore-aware file traversal, and multi-language support. No security concerns — purely local file operations with no network calls or destructive commands.

Watch Out

Script requires Node.js runtime
SKILL.md is primarily in Chinese which may limit accessibility
Regex-based parsing rather than proper AST — may miss edge cases in complex codebases

Missing Dependencies

node

Notes

Solid, clean skill with no security issues. The Chinese-language SKILL.md is comprehensive but may limit international adoption. The script is well-written and could serve as a useful utility. Run script was skipped because .js files aren't in the runner's allowed extensions.

Information

Repository: code-abyss
Stars: 218

Trust Score

Overall88

Security100

Code Quality78

Architecture72

Usefulness55

More from code-abyss

Building Agent Systems

Reference guide for designing single- and multi-agent LLM systems, RAG pipelines, security hardening, and prompt engineering for production agents.

Related Skills

Development Worktree

Create an isolated git worktree for feature work, auto-run project setup, and verify a clean test baseline before development.

Readwise Reader Document Management

Manage Readwise Reader documents: list, save, search, move, tag, highlight, export and bulk-edit via official and custom CLIs.

Bounty Hunter — Atlas

Persona skill: 'Atlas' — a profit-focused developer persona for discovering, evaluating and executing paid bounties or freelance tasks with ROI-aware workflows.

Junshi — Research Advisor

Daily strategic research advisor that scans arXiv/venues, digests papers, and proposes bold, ranked research ideas tailored to the user's profile.

Full Stack Builder

End-to-end builder that scaffolds, implements, tests, and optionally deploys web and API applications from a natural-language specification.

ezBookkeeping API Tools

Command-line API tools for ezBookkeeping: record and query transactions, retrieve accounts/categories/tags, and fetch exchange rates for self-hosted personal fi

Feishu Voice Sender

Convert MP3s and send them as native Feishu voice messages (playable voice clips) to users or groups.

Claw Bench

Benchmarking skill that guides an agent through a structured suite of capability tests and reporting steps for leaderboard submission.

Back to Skills