writing-readme

Generate and update README.md files across repository, account, and organization scopes.

2|1|Updated Feb 22, 2026
One-click install
npx skills add https://github.com/qte77/claude-code-plugins --skill writing-readme-qte77
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-readme
Source: https://github.com/qte77/claude-code-plugins/tree/main/plugins/readme-generator/skills/writing-readme
Command: npx skills add https://github.com/qte77/claude-code-plugins --skill writing-readme-qte77

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Automates the generation and updating of README.md files across repository, account, and organization scopes.

Core Features & Use Cases

  • Scope-aware generation for repository, account profile, and organization profile READMEs.
  • Template-driven outputs using references/templates to ensure consistency with project conventions.
  • Context-aware updates by inspecting existing READMEs, manifests, and license information.
  • Safe write flow with optional user review before applying changes.

Quick Start

Run the writing-readme skill in the target project directory to generate or update the README.md.

Frequently Asked Questions about writing-readme

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

FAQPage Schema
How do I automatically generate README files for multiple repositories?

You can automatically generate README files by running the skill in your target directory, which detects the scope and applies templates to existing manifests. It reads project data and license info to produce compliant documentation without adding content.

Can I update an organization profile README without overwriting existing content?

Yes, updating an organization profile README uses a context-aware flow that inspects existing files before applying changes. It ensures no content not present in the source is introduced, applying updates safely with an optional review step.

How does template-driven README generation work for GitHub projects?

Template-driven README generation works by gathering context from existing files and manifests, then applying appropriate templates to ensure consistency. It detects the target scope from input and reads project data to produce compliant documentation.

What is the best way to keep repository documentation consistent across an account?

The best way to keep documentation consistent is using scope-aware generation that applies templates across repository, account, and organization scopes. It inspects existing READMEs and manifests to ensure uniform compliance with project conventions.

Does automated README generation require manual input for license information?

Automated README generation does not require manual license input because it reads existing license information during context gathering. It combines this data with templates and manifests to safely generate compliant files.

Why does README generation only use content already present in the source?

README generation only uses source content to ensure documentation remains compliant and accurate without hallucination. This safe write flow prevents introducing unverified information, keeping generated files strictly aligned with existing project data.