skills.rest
andrecini
andreciniCOMMUNITY
Explore all skills by this author →
GitHub

write-readme

Generate or update repository README.md from codebase and configuration files.

2|Updated May 2, 2026
Search Tags:#documentation#project setup#readme#developer onboarding#template compliance#repo automation#configuration guide
One-click install
npx skills add https://github.com/andrecini/dotnet-squad-copilot-agent --skill write-readme-andrecini
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-readme
Source: https://github.com/andrecini/dotnet-squad-copilot-agent/tree/main/.claude/skills/write-readme
Command: npx skills add https://github.com/andrecini/dotnet-squad-copilot-agent --skill write-readme-andrecini

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents documentation from becoming outdated by letting you generate or precisely update the repository README.md using the project’s real structure and configuration details.

Core Features & Use Cases

  • README creation from the repository: Detects solution/project structure, runtime assumptions, and environment-variable keys to populate the template consistently.
  • Section-level updates without overwriting everything: Replaces only the selected sections while preserving the rest of the existing README.
  • Safety and template compliance: Enforces a restricted scope to README.md, avoids credentials/real secret values, and follows the readme-template.md structure.

Quick Start

Ask the assistant to generate the README.md for this repository.

Frequently Asked Questions about write-readme

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

FAQPage Schema
How do I generate a README.md from my existing repository codebase?▼

To generate a README.md, the Skill extracts your project structure, runtime assumptions, and environment-variable keys from the codebase, then populates a predefined readme-template.md structure consistently to create the documentation file.

Can I update specific sections of my README without overwriting the entire file?▼

Yes, you can perform section-level updates on your README without a full rewrite. The Skill replaces only the selected documentation sections while strictly preserving the content of all other existing sections.

How does this handle real credentials and secret values in environment variables?▼

It safely handles credentials by enforcing the strict omission of real secret values when extracting environment-variable keys from your configuration files for the README documentation.

Does the generated README require a specific template structure to follow?▼

Yes, the generated README requires strict adherence to a provided readme-template.md structure, ensuring your repository documentation maintains consistent formatting and template compliance.

What languages does the repository documentation generation support for the output?▼

The repository documentation generation supports Portuguese output, enforcing the language requirement when it populates the README.md file from your codebase and configuration details.

Will this modify other files in my repository besides the README?▼

No, it enforces a restricted file scope limited strictly to README.md, ensuring your codebase, configuration files, and other repository assets remain completely untouched during documentation generation.

Related Skills

Explore More Content & Communication Skills→
imbue-aiimbue-ai
213

setup-repo

Generate Sculptor configuration files for code structure, testing, and documentation.

Official
Intermediate
LazyNinja435LazyNinja435
1

README Authoring

Standardize project README creation and maintenance with structured documentation rules.

Community
Basic
VYRE-StudiosVYRE-Studios

documentation

Generate READMEs, API references, and architecture docs from source code.

Official
Intermediate
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic