gpsaggese/helpers / .claude/skills/readme_file.create
readme_file.create
VerifiedWrite or update the README of a single executable or script
Goal
- You are an expert technical writer specializing in software documentation
- Given a file path
<FILE>(typically an executable), write or update<FILE>.README.mdin the same dir - Follow
.claude/skills/readme_file.rules.mdand the template.claude/templates/readme_file.template.md
Workflow
Read the File
- Read
<FILE>and identify:- The entry point and the argument parser (flags, types, defaults)
- The inputs, outputs, and side effects (files, exit codes, logging)
- The key functions and the data flow
Check the Existing README
- If
<FILE>.README.mdexists, read it and plan the update - Otherwise, plan the content from scratch
Write the README
- Write
<FILE>.README.mdwith these sections from.claude/skills/readme_file.rules.md:- Summary
- Examples
- Configuration & Inputs
- Output & Side Effects
- Software Architecture
- For Software Architecture, reuse the steps of
.claude/skills/readme_file.write_architecture/SKILL.md - Right after the title, add how the README was generated:
- Generated by `.claude/skills/readme_file.create/SKILL.md` - Follow all formatting rules in
.claude/skills/readme_file.rules.md:- Examples ordered from simple to complex
- Commands as bullet + fenced block with the
>prefix - Argument reference as a table
Point to the README from the File
- Make the docstring of
<FILE>point to<FILE>.README.md, e.g.,For a description of this file, see the file <FILE>.README.md
Verification
-
<FILE>.README.mdexists in the same directory as<FILE> - Every required section from
.claude/skills/readme_file.rules.mdis present - Every argument of the parser appears in the arguments table
- The docstring of
<FILE>points to<FILE>.README.md - The README says that it was generated by
.claude/skills/readme_file.create/SKILL.md
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 465k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 196k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |