doc-readme
Domain: doc · Model class: free
Description
Section titled “Description”Use this skill when the user wants to work on Generating clear README files optimized for developer onboarding and first successful use. Triggers include “generate a README”, “write a README for this project”, “create an onboarding README”. Do NOT use when document the full API (use core-api-documentation).
Purpose
Section titled “Purpose”Generating clear README files optimized for developer onboarding and first successful use. This skill provides structured guidance, references, and worked examples to help produce high-quality, actionable outputs.
Trigger Phrases
Section titled “Trigger Phrases”- “generate a README”
- “write a README for this project”
- “create an onboarding README”
- “quickstart documentation”
Anti-Triggers
Section titled “Anti-Triggers”- document the full API (use core-api-documentation)
- create operational runbooks (use core-runbook-generator)
Intake Questions
Section titled “Intake Questions”- What is the user’s goal and current state?
- What constraints (time, team, compliance) apply?
- Are there existing artifacts (specs, code, benchmarks) to reference?
Output Contract
Section titled “Output Contract”- documentation artifact
- audience-aware structure
- source-aware coverage
- publication or validation checklist