[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"skill:01M6F0K7R8TMV28ASBBP7JMVGV":3,"skill-same:01M6F0K7R8TMV28ASBBP7JMVGV":114},{"skillNo":4,"name":5,"nameZh":6,"description":7,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":16,"categories":17,"keywords":18,"publishedAt":28,"linkOnly":29,"markdownContent":30,"markdownBody":31,"frontMatter":32,"refName":33,"commitSha":34,"skillDirectory":35,"forksCount":36,"repositoryHtmlUrl":37,"repositoryHomepageUrl":38,"ownerHtmlUrl":39,"ownerBlogUrl":6,"ownerDescription":40,"updatedAt":41,"install":42,"resources":55},"01M6F0K7R8TMV28ASBBP7JMVGV","crafting-effective-readmes",null,"Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.","ComeOnOliver\u002Fskillshub","ComeOnOliver","https:\u002F\u002Favatars.githubusercontent.com\u002Fu\u002F43215937?v=4","01M6E5JNFECJAAVFE0W7SMWWD2","Haoran Shu","01M6E5JNNDQS7AJZDYFQ8TPZCK",66,"MIT","https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002FSKILL.md",[],[19,20,21,22,23,24,25,26,27],"crafting effective readmes","writing","templates","README","use","files","guidance","project","type","2026-11-10 10:12:30",false,"---\nname: crafting-effective-readmes\ndescription: Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.\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","def8531e65114c0fca8fb8551c1871ee0eed705c","skills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes",24,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub","https:\u002F\u002Fskillshub.wtf","https:\u002F\u002Fgithub.com\u002FComeOnOliver","AI & Blockchain Engineer\r\n","2026-06-24 22:07:19",{"source":8,"skillName":5,"commands":43,"prompt":53,"zipAvailable":54},[44,47,50],{"tool":45,"command":46},"npx","npx skills add ComeOnOliver\u002Fskillshub --skill crafting-effective-readmes",{"tool":48,"command":49},"bunx","bunx skills add ComeOnOliver\u002Fskillshub --skill crafting-effective-readmes",{"tool":51,"command":52},"pnpm","pnpm dlx skills add ComeOnOliver\u002Fskillshub --skill crafting-effective-readmes","安装技能，技能地址：https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002FSKILL.md",true,[56,62,66,70,74,78,82,86,90,94,98,102,106,110],{"path":57,"resourceType":58,"resourceTypeDesc":59,"sizeBytes":60,"sourceHtmlUrl":61},"README.md","REFERENCE","参考文档",6035,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002FREADME.md",{"path":63,"resourceType":58,"resourceTypeDesc":59,"sizeBytes":64,"sourceHtmlUrl":65},"references\u002Fart-of-readme.md",24440,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Freferences\u002Fart-of-readme.md",{"path":67,"resourceType":58,"resourceTypeDesc":59,"sizeBytes":68,"sourceHtmlUrl":69},"references\u002Fmake-a-readme.md",6679,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Freferences\u002Fmake-a-readme.md",{"path":71,"resourceType":58,"resourceTypeDesc":59,"sizeBytes":72,"sourceHtmlUrl":73},"references\u002Fstandard-readme-example-maximal.md",1586,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Freferences\u002Fstandard-readme-example-maximal.md",{"path":75,"resourceType":58,"resourceTypeDesc":59,"sizeBytes":76,"sourceHtmlUrl":77},"references\u002Fstandard-readme-example-minimal.md",169,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Freferences\u002Fstandard-readme-example-minimal.md",{"path":79,"resourceType":58,"resourceTypeDesc":59,"sizeBytes":80,"sourceHtmlUrl":81},"references\u002Fstandard-readme-spec.md",9864,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Freferences\u002Fstandard-readme-spec.md",{"path":83,"resourceType":58,"resourceTypeDesc":59,"sizeBytes":84,"sourceHtmlUrl":85},"section-checklist.md",680,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Fsection-checklist.md",{"path":87,"resourceType":58,"resourceTypeDesc":59,"sizeBytes":88,"sourceHtmlUrl":89},"skill-report.json",10727,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Fskill-report.json",{"path":91,"resourceType":58,"resourceTypeDesc":59,"sizeBytes":92,"sourceHtmlUrl":93},"style-guide.md",434,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Fstyle-guide.md",{"path":95,"resourceType":58,"resourceTypeDesc":59,"sizeBytes":96,"sourceHtmlUrl":97},"templates\u002Finternal.md",1952,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Ftemplates\u002Finternal.md",{"path":99,"resourceType":58,"resourceTypeDesc":59,"sizeBytes":100,"sourceHtmlUrl":101},"templates\u002Foss.md",1667,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Ftemplates\u002Foss.md",{"path":103,"resourceType":58,"resourceTypeDesc":59,"sizeBytes":104,"sourceHtmlUrl":105},"templates\u002Fpersonal.md",1078,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Ftemplates\u002Fpersonal.md",{"path":107,"resourceType":58,"resourceTypeDesc":59,"sizeBytes":108,"sourceHtmlUrl":109},"templates\u002Fxdg-config.md",1478,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Ftemplates\u002Fxdg-config.md",{"path":111,"resourceType":58,"resourceTypeDesc":59,"sizeBytes":112,"sourceHtmlUrl":113},"using-references.md",1325,"https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Faiskillstore\u002Fmarketplace\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Fusing-references.md",[115,129,139,148,154,161],{"skillNo":116,"name":117,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":118,"categories":119,"keywords":125,"publishedAt":28},"01M6FKJN13GMG4KY57J3QD8GY5","model-hierarchy-skill","https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Fzscole\u002Fmodel-hierarchy-skill\u002Fmodel-hierarchy-skill\u002FSKILL.md",[120],{"categoryNo":121,"categoryName":122,"taxonomyType":123,"taxonomyTypeDesc":124},"01JBSEEDCAT000000000000023","Skill与智能体开发","SCENARIO","使用场景",[126,127,128],"model","model hierarchy","model hierarchy skill",{"skillNo":130,"name":131,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":132,"categories":133,"keywords":135,"publishedAt":28},"01M6FKJJJ6GCAMR4PPPRD12M5X","zoom-mcp","https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Fzoom\u002Fskills\u002Fzoom-mcp\u002FSKILL.md",[134],{"categoryNo":121,"categoryName":122,"taxonomyType":123,"taxonomyTypeDesc":124},[136,137,138],"MCP","zoom","zoom mcp",{"skillNo":140,"name":141,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":142,"categories":143,"keywords":144,"publishedAt":28},"01M6FKJE3KYT3KPEZMEEHYKA6K","zoom-apps-sdk","https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Fzoom\u002Fskills\u002Fzoom-apps-sdk\u002FSKILL.md",[],[145,146,147,137],"sdk","zoom apps sdk","apps",{"skillNo":149,"name":150,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":151,"categories":152,"keywords":153,"publishedAt":28},"01M6FKJ9EDH9Q5VWDF8HAJRSP0","windows","https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Fzoom\u002Fskills\u002Fwindows\u002FSKILL.md",[],[150],{"skillNo":155,"name":156,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":157,"categories":158,"keywords":160,"publishedAt":28},"01M6FKJ666BEEFC3AE9GJ72Q93","whiteboard","https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Fzoom\u002Fskills\u002Fwhiteboard\u002FSKILL.md",[159],{"categoryNo":121,"categoryName":122,"taxonomyType":123,"taxonomyTypeDesc":124},[156],{"skillNo":162,"name":163,"nameZh":6,"description":6,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":164,"categories":165,"keywords":166,"publishedAt":28},"01M6FKJ21WFCDGTJQ2Q91T9DVW","websockets","https:\u002F\u002Fgithub.com\u002FComeOnOliver\u002Fskillshub\u002Fblob\u002Fmain\u002Fskills\u002Fzoom\u002Fskills\u002Fwebsockets\u002FSKILL.md",[],[163]]