Skill · em Documentar e entregar

crafting-effective-readmes

Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.

Procedência

Antes de instalar

14 arquivos · 58,7 KB · só texto, nenhum script

Instalar na sua CLI

O comando baixa a versão fixada (commit 57f899e) direto da origem, para a pasta que a CLI lê. Precisa de curl (macOS e Linux); no Windows não há comando, porque o Rook Labs é para macOS.

Claude Code

Neste projeto: instala em .claude/skills/crafting-effective-readmes/.

d=".claude/skills/crafting-effective-readmes"
u="https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/cli-tool/components/skills/productivity/crafting-effective-readmes"
curl -fsSL --create-dirs \
  -o "$d/SKILL.md" "$u/SKILL.md" \
  -o "$d/README.md" "$u/README.md" \
  -o "$d/references/art-of-readme.md" "$u/references/art-of-readme.md" \
  -o "$d/references/make-a-readme.md" "$u/references/make-a-readme.md" \
  -o "$d/references/standard-readme-example-maximal.md" "$u/references/standard-readme-example-maximal.md" \
  -o "$d/references/standard-readme-example-minimal.md" "$u/references/standard-readme-example-minimal.md" \
  -o "$d/references/standard-readme-spec.md" "$u/references/standard-readme-spec.md" \
  -o "$d/section-checklist.md" "$u/section-checklist.md" \
  -o "$d/style-guide.md" "$u/style-guide.md" \
  -o "$d/templates/internal.md" "$u/templates/internal.md" \
  -o "$d/templates/oss.md" "$u/templates/oss.md" \
  -o "$d/templates/personal.md" "$u/templates/personal.md" \
  -o "$d/templates/xdg-config.md" "$u/templates/xdg-config.md" \
  -o "$d/using-references.md" "$u/using-references.md" \
  -o "$d/LICENSE" "https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/LICENSE"

Global: instala em ~/.claude/skills/crafting-effective-readmes/.

d="$HOME/.claude/skills/crafting-effective-readmes"
u="https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/cli-tool/components/skills/productivity/crafting-effective-readmes"
curl -fsSL --create-dirs \
  -o "$d/SKILL.md" "$u/SKILL.md" \
  -o "$d/README.md" "$u/README.md" \
  -o "$d/references/art-of-readme.md" "$u/references/art-of-readme.md" \
  -o "$d/references/make-a-readme.md" "$u/references/make-a-readme.md" \
  -o "$d/references/standard-readme-example-maximal.md" "$u/references/standard-readme-example-maximal.md" \
  -o "$d/references/standard-readme-example-minimal.md" "$u/references/standard-readme-example-minimal.md" \
  -o "$d/references/standard-readme-spec.md" "$u/references/standard-readme-spec.md" \
  -o "$d/section-checklist.md" "$u/section-checklist.md" \
  -o "$d/style-guide.md" "$u/style-guide.md" \
  -o "$d/templates/internal.md" "$u/templates/internal.md" \
  -o "$d/templates/oss.md" "$u/templates/oss.md" \
  -o "$d/templates/personal.md" "$u/templates/personal.md" \
  -o "$d/templates/xdg-config.md" "$u/templates/xdg-config.md" \
  -o "$d/using-references.md" "$u/using-references.md" \
  -o "$d/LICENSE" "https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/LICENSE"

Codex

Neste projeto: instala em .agents/skills/crafting-effective-readmes/.

d=".agents/skills/crafting-effective-readmes"
u="https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/cli-tool/components/skills/productivity/crafting-effective-readmes"
curl -fsSL --create-dirs \
  -o "$d/SKILL.md" "$u/SKILL.md" \
  -o "$d/README.md" "$u/README.md" \
  -o "$d/references/art-of-readme.md" "$u/references/art-of-readme.md" \
  -o "$d/references/make-a-readme.md" "$u/references/make-a-readme.md" \
  -o "$d/references/standard-readme-example-maximal.md" "$u/references/standard-readme-example-maximal.md" \
  -o "$d/references/standard-readme-example-minimal.md" "$u/references/standard-readme-example-minimal.md" \
  -o "$d/references/standard-readme-spec.md" "$u/references/standard-readme-spec.md" \
  -o "$d/section-checklist.md" "$u/section-checklist.md" \
  -o "$d/style-guide.md" "$u/style-guide.md" \
  -o "$d/templates/internal.md" "$u/templates/internal.md" \
  -o "$d/templates/oss.md" "$u/templates/oss.md" \
  -o "$d/templates/personal.md" "$u/templates/personal.md" \
  -o "$d/templates/xdg-config.md" "$u/templates/xdg-config.md" \
  -o "$d/using-references.md" "$u/using-references.md" \
  -o "$d/LICENSE" "https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/LICENSE"

Global: instala em ~/.agents/skills/crafting-effective-readmes/.

d="$HOME/.agents/skills/crafting-effective-readmes"
u="https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/cli-tool/components/skills/productivity/crafting-effective-readmes"
curl -fsSL --create-dirs \
  -o "$d/SKILL.md" "$u/SKILL.md" \
  -o "$d/README.md" "$u/README.md" \
  -o "$d/references/art-of-readme.md" "$u/references/art-of-readme.md" \
  -o "$d/references/make-a-readme.md" "$u/references/make-a-readme.md" \
  -o "$d/references/standard-readme-example-maximal.md" "$u/references/standard-readme-example-maximal.md" \
  -o "$d/references/standard-readme-example-minimal.md" "$u/references/standard-readme-example-minimal.md" \
  -o "$d/references/standard-readme-spec.md" "$u/references/standard-readme-spec.md" \
  -o "$d/section-checklist.md" "$u/section-checklist.md" \
  -o "$d/style-guide.md" "$u/style-guide.md" \
  -o "$d/templates/internal.md" "$u/templates/internal.md" \
  -o "$d/templates/oss.md" "$u/templates/oss.md" \
  -o "$d/templates/personal.md" "$u/templates/personal.md" \
  -o "$d/templates/xdg-config.md" "$u/templates/xdg-config.md" \
  -o "$d/using-references.md" "$u/using-references.md" \
  -o "$d/LICENSE" "https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/LICENSE"

Antigravity

Neste projeto: instala em .agents/skills/crafting-effective-readmes/.

d=".agents/skills/crafting-effective-readmes"
u="https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/cli-tool/components/skills/productivity/crafting-effective-readmes"
curl -fsSL --create-dirs \
  -o "$d/SKILL.md" "$u/SKILL.md" \
  -o "$d/README.md" "$u/README.md" \
  -o "$d/references/art-of-readme.md" "$u/references/art-of-readme.md" \
  -o "$d/references/make-a-readme.md" "$u/references/make-a-readme.md" \
  -o "$d/references/standard-readme-example-maximal.md" "$u/references/standard-readme-example-maximal.md" \
  -o "$d/references/standard-readme-example-minimal.md" "$u/references/standard-readme-example-minimal.md" \
  -o "$d/references/standard-readme-spec.md" "$u/references/standard-readme-spec.md" \
  -o "$d/section-checklist.md" "$u/section-checklist.md" \
  -o "$d/style-guide.md" "$u/style-guide.md" \
  -o "$d/templates/internal.md" "$u/templates/internal.md" \
  -o "$d/templates/oss.md" "$u/templates/oss.md" \
  -o "$d/templates/personal.md" "$u/templates/personal.md" \
  -o "$d/templates/xdg-config.md" "$u/templates/xdg-config.md" \
  -o "$d/using-references.md" "$u/using-references.md" \
  -o "$d/LICENSE" "https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/LICENSE"

Global: instala em ~/.gemini/antigravity-cli/skills/crafting-effective-readmes/.

d="$HOME/.gemini/antigravity-cli/skills/crafting-effective-readmes"
u="https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/cli-tool/components/skills/productivity/crafting-effective-readmes"
curl -fsSL --create-dirs \
  -o "$d/SKILL.md" "$u/SKILL.md" \
  -o "$d/README.md" "$u/README.md" \
  -o "$d/references/art-of-readme.md" "$u/references/art-of-readme.md" \
  -o "$d/references/make-a-readme.md" "$u/references/make-a-readme.md" \
  -o "$d/references/standard-readme-example-maximal.md" "$u/references/standard-readme-example-maximal.md" \
  -o "$d/references/standard-readme-example-minimal.md" "$u/references/standard-readme-example-minimal.md" \
  -o "$d/references/standard-readme-spec.md" "$u/references/standard-readme-spec.md" \
  -o "$d/section-checklist.md" "$u/section-checklist.md" \
  -o "$d/style-guide.md" "$u/style-guide.md" \
  -o "$d/templates/internal.md" "$u/templates/internal.md" \
  -o "$d/templates/oss.md" "$u/templates/oss.md" \
  -o "$d/templates/personal.md" "$u/templates/personal.md" \
  -o "$d/templates/xdg-config.md" "$u/templates/xdg-config.md" \
  -o "$d/using-references.md" "$u/using-references.md" \
  -o "$d/LICENSE" "https://raw.githubusercontent.com/davila7/claude-code-templates/57f899e5394bb8ca166f38eacae8f0853cbfe033/LICENSE"

Peça ao Rook

Já usa o Rook Labs? Cole no chat do Rook: instale a skill https://rooklabs.sh/marketplace/cct.crafting-effective-readmes

Prévia do SKILL.md

---
name: crafting-effective-readmes
description: Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.
---

# Crafting Effective READMEs

## Overview

READMEs answer questions your audience will have. Different audiences need different information - a contributor to an OSS project needs different context than future-you opening a config folder.

**Always ask:** Who will read this, and what do they need to know?

## Process

### Step 1: Identify the Task

**Ask:** "What README task are you working on?"

| Task | When |
|------|------|
| **Creating** | New project, no README yet |
| **Adding** | Need to document something new |
| **Updating** | Capabilities changed, content is stale |
| **Reviewing** | Checking if README is still accurate |

### Step 2: Task-Specific Questions

**Creating initial README:**
1. What type of project? (see Project Types below)
2. What problem does this solve in one sentence?
3. What's the quickest path to "it works"?
4. Anything notable to highlight?

**Adding a section:**
1. What needs documenting?
2. Where should it go in the existing structure?
3. Who needs this info most?

**Updating existing content:**
…

Ver todo o marketplace