documentation-generator

Name: documentation-generator
Availability: InStock
Author: khamel83

Generate and synchronize README, LLM-OVERVIEW, and ADR documentation from codebases.

Updated Nov 22, 2025

Search Tags:#automation #documentation #markdown #adr #readme #docs-generation #llm-overview

Ready to run

npx skills add https://github.com/Khamel83/oneshot --skill documentation-generator-khamel83

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-generator
Source: https://github.com/Khamel83/oneshot/tree/main/archive/v9/skills/documentation-generator
Command: npx skills add https://github.com/Khamel83/oneshot --skill documentation-generator-khamel83

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates and updates project documentation (README, LLM-OVERVIEW, ADRs) to keep docs in sync with the codebase, reducing divergence and manual effort.

Core Features & Use Cases

Generates README.md with quick start, features, and configuration sections.
Produces LLM-OVERVIEW.md to document architecture and current state.
Creates ADRs for major decisions and tracks architectural history.

Quick Start

Run the documentation-generator tool against your project to automatically produce updated markdown artifacts for codebases.

Frequently Asked Questions about documentation-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I automatically generate and sync project documentation like README and ADRs?▼

To automatically generate and sync project documentation, you run a tool that scans your codebase, extracts metadata, and fills markdown templates for README.md, LLM-OVERVIEW.md, and ADRs to keep docs aligned with code changes.

What is an LLM-OVERVIEW.md file and when do I need to generate it?▼

An LLM-OVERVIEW.md file documents your project's architecture and current state for AI models. You generate it when you want to provide large language models with a structured technical overview of your codebase.

Can I customize the markdown templates used for generating README files?▼

Yes, the documentation generation process supports template-based customization, allowing you to define and populate specific markdown templates for README.md sections like quick start, features, and configuration.

What is the best way to track architectural decisions as my codebase changes?▼

The best way to track architectural decisions is by using a tool that automatically outputs ADRs, or Architecture Decision Records, and syncs them with code changes to ensure your architectural history stays aligned.

Does this documentation generation approach work without external dependencies?▼

Yes, the documentation generator operates with no external dependencies, allowing you to directly scan your codebase and extract metadata to produce markdown artifacts within a self-contained workflow.