[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"skill:01M75BEXFN0J8CB4N85Z1Q1NSZ":3,"skill-same:01M75BEXFN0J8CB4N85Z1Q1NSZ":45},{"skillNo":4,"name":5,"nameZh":6,"description":7,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":6,"repositoryNo":12,"starsCount":13,"licenseSpdxId":14,"licenseFileUrl":6,"sourceHtmlUrl":15,"categories":16,"keywords":17,"publishedAt":18,"linkOnly":19,"markdownContent":20,"markdownBody":21,"frontMatter":22,"refName":23,"commitSha":24,"skillDirectory":25,"forksCount":26,"repositoryHtmlUrl":27,"repositoryHomepageUrl":28,"ownerHtmlUrl":29,"ownerBlogUrl":6,"ownerDescription":6,"updatedAt":30,"install":31,"resources":44},"01M75BEXFN0J8CB4N85Z1Q1NSZ","crafting-effective-readmes",null,"READMEs answer questions your audience will have. Different audiences need different information - a contributor to an O","ruake\u002FAWARE","ruake","https:\u002F\u002Favatars.githubusercontent.com\u002Fu\u002F253885939?v=4","01M75AVBM7FRFTS61RZRNMZB6C","01M75AVBMYHD7500NHVANF1HKM",0,"MIT","https:\u002F\u002Fgithub.com\u002Fruake\u002FAWARE\u002Fblob\u002Fmain\u002F.opencode\u002Fskills\u002Fcrafting-effective-readmes\u002FSKILL.md",[],[],"2026-11-12 13:55:43",false,"---\nname: crafting-effective-readmes\ndescription: READMEs answer questions your audience will have. Different audiences need different information - a contributor to an O\n---\n\n# Crafting Effective READMEs\n\n## Overview\n\nREADMEs 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.\n\n**Always ask:** Who will read this, and what do they need to know?\n\n## Process\n\n### Step 1: Identify the Task\n\n**Ask:** \"What README task are you working on?\"\n\n| Task | When |\n|------|------|\n| **Creating** | New project, no README yet |\n| **Adding** | Need to document something new |\n| **Updating** | Capabilities changed, content is stale |\n| **Reviewing** | Checking if README is still accurate |\n\n### Step 2: Task-Specific Questions\n\n**Creating initial README:**\n1. What type of project? (see Project Types below)\n2. What problem does this solve in one sentence?\n3. What's the quickest path to \"it works\"?\n4. Anything notable to highlight?\n\n**Adding a section:**\n1. What needs documenting?\n2. Where should it go in the existing structure?\n3. Who needs this info most?\n\n**Updating existing content:**\n1. What changed?\n2. Read current README, identify stale sections\n3. Propose specific edits\n\n**Reviewing\u002Frefreshing:**\n1. Read current README\n2. Check against actual project state (package.json, main files, etc.)\n3. Flag outdated sections\n4. Update \"Last reviewed\" date if present\n\n### Step 3: Always Ask\n\nAfter drafting, ask: **\"Anything else to highlight or include that I might have missed?\"**\n\n## Project Types\n\n| Type | Audience | Key Sections | Template |\n|------|----------|--------------|----------|\n| **Open Source** | Contributors, users worldwide | Install, Usage, Contributing, License | `templates\u002Foss.md` |\n| **Personal** | Future you, portfolio viewers | What it does, Tech stack, Learnings | `templates\u002Fpersonal.md` |\n| **Internal** | Teammates, new hires | Setup, Architecture, Runbooks | `templates\u002Finternal.md` |\n| **Config** | Future you (confused) | What's here, Why, How to extend, Gotchas | `templates\u002Fxdg-config.md` |\n\n**Ask the user** if unclear. Don't assume OSS defaults for everything.\n\n## Essential Sections (All Types)\n\nEvery README needs at minimum:\n\n1. **Name** - Self-explanatory title\n2. **Description** - What + why in 1-2 sentences  \n3. **Usage** - How to use it (examples help)\n\n## References\n\n- `section-checklist.md` - Which sections to include by project type\n- `style-guide.md` - Common README mistakes and prose guidance\n- `using-references.md` - Guide to deeper reference materials\n","# Crafting Effective READMEs\n\n## Overview\n\nREADMEs 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.\n\n**Always ask:** Who will read this, and what do they need to know?\n\n## Process\n\n### Step 1: Identify the Task\n\n**Ask:** \"What README task are you working on?\"\n\n| Task | When |\n|------|------|\n| **Creating** | New project, no README yet |\n| **Adding** | Need to document something new |\n| **Updating** | Capabilities changed, content is stale |\n| **Reviewing** | Checking if README is still accurate |\n\n### Step 2: Task-Specific Questions\n\n**Creating initial README:**\n1. What type of project? (see Project Types below)\n2. What problem does this solve in one sentence?\n3. What's the quickest path to \"it works\"?\n4. Anything notable to highlight?\n\n**Adding a section:**\n1. What needs documenting?\n2. Where should it go in the existing structure?\n3. Who needs this info most?\n\n**Updating existing content:**\n1. What changed?\n2. Read current README, identify stale sections\n3. Propose specific edits\n\n**Reviewing\u002Frefreshing:**\n1. Read current README\n2. Check against actual project state (package.json, main files, etc.)\n3. Flag outdated sections\n4. Update \"Last reviewed\" date if present\n\n### Step 3: Always Ask\n\nAfter drafting, ask: **\"Anything else to highlight or include that I might have missed?\"**\n\n## Project Types\n\n| Type | Audience | Key Sections | Template |\n|------|----------|--------------|----------|\n| **Open Source** | Contributors, users worldwide | Install, Usage, Contributing, License | `templates\u002Foss.md` |\n| **Personal** | Future you, portfolio viewers | What it does, Tech stack, Learnings | `templates\u002Fpersonal.md` |\n| **Internal** | Teammates, new hires | Setup, Architecture, Runbooks | `templates\u002Finternal.md` |\n| **Config** | Future you (confused) | What's here, Why, How to extend, Gotchas | `templates\u002Fxdg-config.md` |\n\n**Ask the user** if unclear. Don't assume OSS defaults for everything.\n\n## Essential Sections (All Types)\n\nEvery README needs at minimum:\n\n1. **Name** - Self-explanatory title\n2. **Description** - What + why in 1-2 sentences  \n3. **Usage** - How to use it (examples help)\n\n## References\n\n- `section-checklist.md` - Which sections to include by project type\n- `style-guide.md` - Common README mistakes and prose guidance\n- `using-references.md` - Guide to deeper reference materials\n",{"name":5,"description":7},"main","6184979e01f673905139589c194eab38198db2f7",".opencode\u002Fskills\u002Fcrafting-effective-readmes",1,"https:\u002F\u002Fgithub.com\u002Fruake\u002FAWARE","https:\u002F\u002Fruake.github.io\u002FAWARE","https:\u002F\u002Fgithub.com\u002Fruake","2026-11-15 04:27:27",{"source":8,"skillName":5,"commands":32,"prompt":42,"zipAvailable":43},[33,36,39],{"tool":34,"command":35},"npx","npx skills add ruake\u002FAWARE --skill crafting-effective-readmes",{"tool":37,"command":38},"bunx","bunx skills add ruake\u002FAWARE --skill crafting-effective-readmes",{"tool":40,"command":41},"pnpm","pnpm dlx skills add ruake\u002FAWARE --skill crafting-effective-readmes","安装技能，技能地址：https:\u002F\u002Fgithub.com\u002Fruake\u002FAWARE\u002Fblob\u002Fmain\u002F.opencode\u002Fskills\u002Fcrafting-effective-readmes\u002FSKILL.md",true,[],[46,52,59,66,73,79],{"skillNo":47,"name":48,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":6,"repositoryNo":12,"starsCount":13,"licenseSpdxId":14,"licenseFileUrl":6,"sourceHtmlUrl":49,"categories":50,"keywords":51,"publishedAt":18},"01M75BPBYT89TEE87CGBDX2KF5","xlsx","https:\u002F\u002Fgithub.com\u002Fruake\u002FAWARE\u002Fblob\u002Fmain\u002F.opencode\u002Fskills\u002Fxlsx\u002FSKILL.md",[],[],{"skillNo":53,"name":54,"nameZh":6,"description":55,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":6,"repositoryNo":12,"starsCount":13,"licenseSpdxId":14,"licenseFileUrl":6,"sourceHtmlUrl":56,"categories":57,"keywords":58,"publishedAt":18},"01M75BPA000S9MTH5MY7CZNYYQ","writing-plans","Write comprehensive implementation plans assuming the engineer has zero context for our codebase and questionable taste.","https:\u002F\u002Fgithub.com\u002Fruake\u002FAWARE\u002Fblob\u002Fmain\u002F.opencode\u002Fskills\u002Fwriting-plans\u002FSKILL.md",[],[],{"skillNo":60,"name":61,"nameZh":6,"description":62,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":6,"repositoryNo":12,"starsCount":13,"licenseSpdxId":14,"licenseFileUrl":6,"sourceHtmlUrl":63,"categories":64,"keywords":65,"publishedAt":18},"01M75BP80ETH9GYVRH8A7QPCSG","web-design-guidelines","Review files for compliance with Web Interface Guidelines.","https:\u002F\u002Fgithub.com\u002Fruake\u002FAWARE\u002Fblob\u002Fmain\u002F.opencode\u002Fskills\u002Fweb-design-guidelines\u002FSKILL.md",[],[],{"skillNo":67,"name":68,"nameZh":6,"description":69,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":6,"repositoryNo":12,"starsCount":13,"licenseSpdxId":14,"licenseFileUrl":6,"sourceHtmlUrl":70,"categories":71,"keywords":72,"publishedAt":18},"01M75BP5XG8SX5Q2WWZB6QRVFT","web-component-design","Build reusable, maintainable UI components using modern frameworks with clean composition patterns and styling approache","https:\u002F\u002Fgithub.com\u002Fruake\u002FAWARE\u002Fblob\u002Fmain\u002F.opencode\u002Fskills\u002Fweb-component-design\u002FSKILL.md",[],[],{"skillNo":74,"name":75,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":6,"repositoryNo":12,"starsCount":13,"licenseSpdxId":14,"licenseFileUrl":6,"sourceHtmlUrl":76,"categories":77,"keywords":78,"publishedAt":18},"01M75BP4B1FC4V81QR1VB56H1E","web-artifacts-builder","https:\u002F\u002Fgithub.com\u002Fruake\u002FAWARE\u002Fblob\u002Fmain\u002F.opencode\u002Fskills\u002Fweb-artifacts-builder\u002FSKILL.md",[],[],{"skillNo":80,"name":81,"nameZh":6,"description":82,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":6,"repositoryNo":12,"starsCount":13,"licenseSpdxId":14,"licenseFileUrl":6,"sourceHtmlUrl":83,"categories":84,"keywords":85,"publishedAt":18},"01M75BP1XVRW8WQ2XXAJBAYV2V","vueuse-functions","This skill is a decision-and-implementation guide for VueUse composables in Vue.js \u002F Nuxt projects. It maps requirements","https:\u002F\u002Fgithub.com\u002Fruake\u002FAWARE\u002Fblob\u002Fmain\u002F.opencode\u002Fskills\u002Fvueuse-functions\u002FSKILL.md",[],[]]