Professional Repo Docs Skill
ChanMeng666/professional-repo-docs-skill
Scaffolding completo de docs GitHub profissionais, agent-first, em uma invocação
Ver no GitHubUma skill Claude Code que gera automaticamente documentação profissional e orientada a agentes para repositórios GitHub. Cria README, LICENSE, templates de issues/PRs, AGENTS.md, llms.txt e arquivos de comunidade em um único comando, seguindo boas práticas e nunca sobrescrevendo arquivos existentes.
Instalação
npx convez-ai ChanMeng666/professional-repo-docs-skill1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.
Métricas
Casos de uso
- Inicializar documentação profissional para novos projetos open-source
- Padronizar repositórios com templates de issues, PRs e governance
- Gerar guias agent-facing (AGENTS.md, llms.txt) para automação
- Configurar comunidade-health files e licenças canonicamente
Veredito

Ferramenta bem pensada que resolve um problema real — documentação de repositórios é tedioso, e esta skill automatiza tudo sem clobber files ou fazer commits. Ideal para quem quer repos profissionais rapidamente, especialmente com foco em agent-first e open-source.
README
A tradução para o português deste README ainda está na fila.
[!IMPORTANT]
🤖 Read this with your AI agent — don't read it by hand.
This repo is written agent-first. Point Claude Code, GitHub Copilot, Cursor, or any agent at it: "Read the README and SKILL.md, then install and use this skill."
🪄 professional-repo-docs
A Claude Code skill that scaffolds professional, agent-first GitHub repository documentation
Turn any project folder into a polished, best-practice GitHub repo with one invocation — README,
LICENSE, community-health files, issue/PR templates, AGENTS.md, and more.
What it does
When installed, Claude Code can bootstrap a project's entire documentation set from a natural-language request like "set up the docs for my new project" or "make this repo professional". It generates:
README.md | lite or full, agent-first notice on top, personal-brand block at bottom |
LICENSE | chosen by project type (MIT, Apache-2.0, GPL/AGPL/LGPL-3.0, CC-BY-4.0, CC0-1.0) |
.github/FUNDING.yml | wired to GitHub Sponsors + Buy Me a Coffee |
CODE_OF_CONDUCT.md | Contributor Covenant 2.1 (copied verbatim) |
CONTRIBUTING.md | with real per-stack build/test commands |
SECURITY.md · SUPPORT.md · GOVERNANCE.md · CHANGELOG.md | community-health set |
CITATION.cff | optional, for research/academic projects |
.github/ISSUE_TEMPLATE/* · PULL_REQUEST_TEMPLATE.md | structured contribution templates |
AGENTS.md · llms.txt | agent-facing project guides |
Principles: copies canonical license/CoC text verbatim (never regenerates it), only creates files that are missing (never clobbers your work), brands every README, and never auto-commits.
Prerequisites
- Node.js 18+ (the
scaffold.mjsengine is plain Node, cross-platform). ghCLI (optional) — only for the post-setup step that enables Discussions.
Installation
Pick one method.
Method 1 — Claude Code plugin marketplace (recommended)
/plugin marketplace add ChanMeng666/professional-repo-docs-skill
/plugin install professional-repo-docs@chan-repo-docs
Method 2 — Git clone into your skills folder
The skill content lives at skills/professional-repo-docs/. Copy that subfolder into your
user-level skills directory:
# macOS / Linux / Windows (Git Bash or WSL)
git clone --depth 1 https://github.com/ChanMeng666/professional-repo-docs-skill.git /tmp/_prd-src \
&& mv /tmp/_prd-src/skills/professional-repo-docs ~/.claude/skills/professional-repo-docs \
&& rm -rf /tmp/_prd-src
Windows PowerShell: replace
~with$env:USERPROFILE(destination$env:USERPROFILE\.claude\skills\professional-repo-docs), and useMove-Item/Remove-Item -Recurse.
Method 3 — Symlink (hack on the skill live)
git clone https://github.com/ChanMeng666/professional-repo-docs-skill.git
cd professional-repo-docs-skill
ln -s "$(pwd)/skills/professional-repo-docs" ~/.claude/skills/professional-repo-docs
# Windows PowerShell (Administrator)
New-Item -ItemType SymbolicLink `
-Path "$env:USERPROFILE\.claude\skills\professional-repo-docs" `
-Target "$(Resolve-Path .\skills\professional-repo-docs)"
Usage
Once installed, just ask Claude Code in your project:
"Set up professional GitHub docs for this repo."
Claude will detect your stack, suggest a license, ask README depth (lite/full), generate everything, and print the two post-setup steps (enable Discussions + the Sponsorships toggle).
You can also run the engine directly:
node skills/professional-repo-docs/scripts/scaffold.mjs --readme lite --license MIT
# flags: --dir <path> --readme full|lite|none --license <SPDX> --citation --no-llms --no-agents --force
❤️ Sponsor
📄 License
Released under the MIT license.