- name
SKILL.md
技能檔案保留在發布者的儲存庫中。
在終端機中貼上複製的指令。它會將這個 SKILL.md 安裝到對應的代理中。
npx skills add softaworks/agent-toolkit --skill crafting-effective-readmes -a cursor -y在終端機中貼上複製的指令。它會將這個 SKILL.md 安裝到對應的代理中。
npx skills add softaworks/agent-toolkit --skill crafting-effective-readmes -a claude-code -y在終端機中貼上複製的指令。它會將這個 SKILL.md 安裝到對應的代理中。
npx skills add softaworks/agent-toolkit --skill crafting-effective-readmes -a codex -y在終端機中貼上複製的指令。它會將這個 SKILL.md 安裝到對應的代理中。
npx skills add softaworks/agent-toolkit --skill crafting-effective-readmes -a grok -y在 Grok Bot 聊天中傳送複製的訊息。Bot 會從 GitHub 取得這個 SKILL.md,並加入你所有 Bot 共用的技能中。
Install this skill: https://github.com/softaworks/agent-toolkit/tree/HEAD/dist/plugins/crafting-effective-readmes/skills/crafting-effective-readmes來自發布者
READMEs 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.
Always ask: Who will read this, and what do they need to know?
Ask: "What README task are you working on?"
Creating initial README:
Adding a section:
Updating existing content:
Reviewing/refreshing:
After drafting, ask: "Anything else to highlight or include that I might have missed?"
Ask the user if unclear. Don't assume OSS defaults for everything.
Every README needs at minimum:
section-checklist.md - Which sections to include by project typestyle-guide.md - Common README mistakes and prose guidanceusing-references.md - Guide to deeper reference materialsUse when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.
---name: crafting-effective-readmesdescription: Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance…---# dist/plugins/crafting-effective-readmes/skills/crafting-effective-readmes/SKILL.md常見問題
從發布者下載 dist/plugins/crafting-effective-readmes/skills/crafting-effective-readmes/SKILL.md,或複製路徑後開啟儲存庫。PlugMCP 只收錄這項技能,不代管檔案。
發布者將它存放在 https://github.com/softaworks/agent-toolkit。
Claude、Cursor、Codex 和 Grok Build 可以讀取你從發布者儲存庫加入的 SKILL.md。在聊天中傳送技能的 GitHub 資料夾連結,Grok Bot 就會安裝它。