
from code-abyss238
Generates README.md and DESIGN.md scaffolds from a module's code and structure to accelerate project documentation.
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.
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.
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).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.
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.
nodeSolid, 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.
Building Agent Systems
Reference guide for designing single- and multi-agent LLM systems, RAG pipelines, security hardening, and prompt engineering for production agents.
Module Completeness Verifier
Scans directory structures to detect missing documentation and ensures synchronization between code and design documents.