buff-docs

Generate GitHub-standard README and docs/ folders from existing project sources.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/qkal/claude-beta-script --skill buff-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: buff-docs
Source: https://github.com/qkal/claude-beta-script/tree/main/skills/docs
Command: npx skills add https://github.com/qkal/claude-beta-script --skill buff-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Modern projects often struggle with keeping documentation up-to-date and consistent. buff-docs automates the generation of modern, minimal, GitHub-style documentation that adapts to project size and existing artifacts.

Core Features & Use Cases

  • Generates a clean README and docs/ folder tailored to the project's size and existing sources.
  • Infers style and structure from current docs and package metadata to produce publish-ready content.
  • Creates an API reference and changelog when relevant sources exist.

Quick Start

Run buff-docs on your project to generate a README and a docs/ folder.

Frequently Asked Questions about buff-docs

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

FAQPage Schema
How do I generate GitHub-standard documentation for an existing project?▼

To generate GitHub-standard documentation, the Skill reads your existing README, docs/ folder, and package metadata, infers the current style, and outputs a ready-to-publish suite including an updated README and docs/ folder.

What is the best way to create a minimal README and docs folder from scratch?▼

Creating a minimal README and docs folder is best handled by inferring structure from project size and existing artifacts, which this Skill uses to produce modern, minimal, GitHub-style documentation automatically.

Can I generate an API reference and changelog from existing project sources?▼

Yes, you can generate an API reference and changelog when relevant sources exist in your project, as the documentation generator automatically creates these optional components alongside the main README.

Does the documentation generator update existing markdown files or only create new ones?▼

The documentation generator both creates and updates existing markdown files by reading current docs, inferring style from existing artifacts, and outputting ready-to-publish content tailored to the project size.

Do I need any dependencies to generate publish-ready project documentation?▼

You do not need any dependencies to generate publish-ready project documentation, as the Skill operates without external dependencies to read sources and output the README, docs/, and optional API reference.