[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"skill:01M6P0286HZ8RWMFCCPC8HF7SC":3,"skill-same:01M6P0286HZ8RWMFCCPC8HF7SC":108},{"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":6,"ownerHtmlUrl":38,"ownerBlogUrl":6,"ownerDescription":6,"updatedAt":39,"install":40,"resources":53},"01M6P0286HZ8RWMFCCPC8HF7SC","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.","mattonweb\u002Fai-assistant-foundry","mattonweb","https:\u002F\u002Favatars.githubusercontent.com\u002Fu\u002F2309734?v=4","01M6NQYCY846TKYN2ZCRS71WQ7","Matt Johnson","01M6NQYD2NPAQEFVD8TW9W0SVX",1,"MIT","https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\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","d8518247cb8ab8b2dac57a6be33543ffd23b97c5","write-technical\u002Fsoftaworks\u002Fcrafting-effective-readmes",0,"https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry","https:\u002F\u002Fgithub.com\u002Fmattonweb","2026-05-29 08:42:23",{"source":8,"skillName":5,"commands":41,"prompt":51,"zipAvailable":52},[42,45,48],{"tool":43,"command":44},"npx","npx skills add mattonweb\u002Fai-assistant-foundry --skill crafting-effective-readmes",{"tool":46,"command":47},"bunx","bunx skills add mattonweb\u002Fai-assistant-foundry --skill crafting-effective-readmes",{"tool":49,"command":50},"pnpm","pnpm dlx skills add mattonweb\u002Fai-assistant-foundry --skill crafting-effective-readmes","安装技能，技能地址：https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002FSKILL.md",true,[54,60,64,68,72,76,80,84,88,92,96,100,104],{"path":55,"resourceType":56,"resourceTypeDesc":57,"sizeBytes":58,"sourceHtmlUrl":59},"README.md","REFERENCE","参考文档",6186,"https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002FREADME.md",{"path":61,"resourceType":56,"resourceTypeDesc":57,"sizeBytes":62,"sourceHtmlUrl":63},"references\u002Fart-of-readme.md",24440,"https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Freferences\u002Fart-of-readme.md",{"path":65,"resourceType":56,"resourceTypeDesc":57,"sizeBytes":66,"sourceHtmlUrl":67},"references\u002Fmake-a-readme.md",6678,"https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Freferences\u002Fmake-a-readme.md",{"path":69,"resourceType":56,"resourceTypeDesc":57,"sizeBytes":70,"sourceHtmlUrl":71},"references\u002Fstandard-readme-example-maximal.md",1586,"https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Freferences\u002Fstandard-readme-example-maximal.md",{"path":73,"resourceType":56,"resourceTypeDesc":57,"sizeBytes":74,"sourceHtmlUrl":75},"references\u002Fstandard-readme-example-minimal.md",169,"https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Freferences\u002Fstandard-readme-example-minimal.md",{"path":77,"resourceType":56,"resourceTypeDesc":57,"sizeBytes":78,"sourceHtmlUrl":79},"references\u002Fstandard-readme-spec.md",9864,"https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Freferences\u002Fstandard-readme-spec.md",{"path":81,"resourceType":56,"resourceTypeDesc":57,"sizeBytes":82,"sourceHtmlUrl":83},"section-checklist.md",680,"https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Fsection-checklist.md",{"path":85,"resourceType":56,"resourceTypeDesc":57,"sizeBytes":86,"sourceHtmlUrl":87},"style-guide.md",434,"https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Fstyle-guide.md",{"path":89,"resourceType":56,"resourceTypeDesc":57,"sizeBytes":90,"sourceHtmlUrl":91},"templates\u002Finternal.md",1946,"https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Ftemplates\u002Finternal.md",{"path":93,"resourceType":56,"resourceTypeDesc":57,"sizeBytes":94,"sourceHtmlUrl":95},"templates\u002Foss.md",1667,"https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Ftemplates\u002Foss.md",{"path":97,"resourceType":56,"resourceTypeDesc":57,"sizeBytes":98,"sourceHtmlUrl":99},"templates\u002Fpersonal.md",1078,"https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Ftemplates\u002Fpersonal.md",{"path":101,"resourceType":56,"resourceTypeDesc":57,"sizeBytes":102,"sourceHtmlUrl":103},"templates\u002Fxdg-config.md",1478,"https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Ftemplates\u002Fxdg-config.md",{"path":105,"resourceType":56,"resourceTypeDesc":57,"sizeBytes":106,"sourceHtmlUrl":107},"using-references.md",1323,"https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsoftaworks\u002Fcrafting-effective-readmes\u002Fusing-references.md",[109,144,164,185,211,234],{"skillNo":110,"name":111,"nameZh":6,"description":112,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":113,"categories":114,"keywords":125,"publishedAt":28},"01M6P02DENRHN6KVGYC55FKASJ","writing-clearly-and-concisely","Use when writing prose humans will read—documentation, commit messages, error messages, explanations, reports, or UI text. Applies Strunk's timeless rules for clearer, stronger, more professional writing.","https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsoftaworks\u002Fwriting-clearly-and-concisely\u002FSKILL.md",[115,120],{"categoryNo":116,"categoryName":117,"taxonomyType":118,"taxonomyTypeDesc":119},"01JBSEEDCAT000000000000018","写作与文案","SCENARIO","使用场景",{"categoryNo":121,"categoryName":122,"taxonomyType":123,"taxonomyTypeDesc":124},"01JBSEEDCAT000000000000036","内容创作者","PROFESSION","适用职业",[20,126,127,128,129,130,131,132,133,134,135,136,23,137,138,139,140,141,142,143],"writing clearly and concisely","concisely","commit","documentation","ui","error messages","messages","commit messages","text","Rules","read","reports","prose","professional","error","timeless","more","for",{"skillNo":145,"name":146,"nameZh":6,"description":147,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":148,"categories":149,"keywords":153,"publishedAt":28},"01M6P025A41BBTPWVTZ3GFQVG6","wiki-architect","You are a documentation architect that produces structured wiki catalogues and onboarding guides from codebases.","https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsickn33\u002Fwiki-architect\u002FSKILL.md",[150],{"categoryNo":151,"categoryName":152,"taxonomyType":123,"taxonomyTypeDesc":124},"01JBSEEDCAT000000000000038","人力资源",[154,155,156,129,157,158,159,160,161,162,163],"wiki architect","architect","wiki","onboarding","community","structured","guides","documentation architect","you","unknown",{"skillNo":165,"name":166,"nameZh":6,"description":167,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":168,"categories":169,"keywords":170,"publishedAt":28},"01M6P01NSKPXP77NWB4K0PXRK5","readme","You are an expert technical writer creating comprehensive project documentation. Your goal is to write a README.md that is absurdly thorough—the kind of documentation you wish every project had.","https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fsickn33\u002Freadme\u002FSKILL.md",[],[22,171,172,129,173,174,175,176,177,178,33,179,180,26,181,162,182,183,184],"safe","github","https","technical","technical writer","write","goal","expert","writer","wish","write a readme","kind","tree","project documentation",{"skillNo":186,"name":187,"nameZh":6,"description":188,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":189,"categories":190,"keywords":191,"publishedAt":28},"01M6P01GP0NEN8KT3A3SA6ZFVE","ubiquitous-language","Extract a DDD-style ubiquitous language glossary from the current conversation, flagging ambiguities and proposing canonical terms. Saves to UBIQUITOUS_LANGUAGE.md. Use when user wants to define domain terms, build a glossary, harden terminology, create a ubiquitous language, or mentions \"domain model\" or \"DDD\".","https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fmattpocock\u002Fubiquitous-language\u002FSKILL.md",[],[192,193,194,195,196,197,198,199,200,23,201,202,203,204,205,206,207,208,209,210],"ubiquitous language","language","create","ddd","terms","model","glossary","user","extract","build","conversation","terminology","domain","domain model","harden","define","style","canonical","true",{"skillNo":212,"name":213,"nameZh":6,"description":214,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":215,"categories":216,"keywords":219,"publishedAt":28},"01M6P01BJBP9XP4TDRT7QD1ZVA","technical-writing-style","Enforce clear, direct writing in software development documents including OKRs, PRDs, tech specs, architecture decision records (ADRs), git commit messages, PR descriptions, READMEs, changelogs, runbooks, incident postmortems, API docs, and onboarding guides. Trigger whenever a user asks to write, edit, revise, or review any of these document types. Also trigger when the user says writing \"sounds like AI\", \"feels robotic\", \"needs polish\", or asks to \"make it sound more natural\" in the context of technical or professional prose. Do not trigger for fiction, poetry, creative writing, academic papers, or legal documents unless the user explicitly asks for a more natural tone.","https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fmattnebr\u002Ftechnical-writing-style\u002FSKILL.md",[217,218],{"categoryNo":116,"categoryName":117,"taxonomyType":118,"taxonomyTypeDesc":119},{"categoryNo":121,"categoryName":122,"taxonomyType":123,"taxonomyTypeDesc":124},[20,220,174,221,208,222,223,128,224,225,132,226,227,228,229,230,139,231,232,233],"technical writing","writing style","technical writing style","review","architecture","documents","api","decision","Poetry","incident","software development","runbooks","types","papers",{"skillNo":235,"name":236,"nameZh":6,"description":237,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":238,"categories":239,"keywords":243,"publishedAt":28},"01M6P00VB9MFBY3FWYZ11V1783","tldr-prompt","Create tldr summaries for GitHub Copilot files (prompts, agents, instructions, collections), MCP servers, or documentation from URLs and queries.","https:\u002F\u002Fgithub.com\u002Fmattonweb\u002Fai-assistant-foundry\u002Fblob\u002Fmain\u002Fwrite-technical\u002Fgithub\u002Ftldr-prompt\u002FSKILL.md",[240],{"categoryNo":241,"categoryName":242,"taxonomyType":118,"taxonomyTypeDesc":119},"01JBSEEDCAT000000000000023","Skill与智能体开发",[244,245,246,247,172,248,249,129,194,250,251,252,24,253,254,143,255,256],"tldr prompt","tldr","prompt","MCP","github copilot","copilot","mcp servers","instructions","prompts","queries","collections","summaries","servers"]