Community生產力與協作github.com

mtai0524/claude-skills

當功能、設定或配置變更時,保持 README.md 與專案文件同步。在新增功能、變更安裝步驟、加入環境變數或用戶要求更新文件後使用。

claude-skills 是什麼?

此技能旨在確保專案的 README.md 及其他文件能與程式碼變更保持同步。當開發者新增功能、修改安裝步驟、加入環境變數或用戶要求更新文件時,此技能會自動觸發文件更新。它支援多種 AI Agent 平台(如 Claude Code、Cursor、Codex 等),並透過分析專案變更來識別需要更新的文件區塊。技能的核心運作方式是根據 SKILL.md 中的規則,僅更新受影響的區塊,而非重寫整個文件,並確保所有記錄的命令實際可執行。它特別強調文件的簡潔性與準確性,避免使用行銷語言,專注於提供精準的技術說明。

相容平台✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/mtai0524/claude-skills/tree/HEAD/skills/docs-readme

Installed? Explore more 生產力與協作 skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

文件與 README

當某項變更影響他人安裝、執行、設定或使用專案的方式時,請在相同的變更中更新 README.md。

README 應簡要涵蓋以下內容:

  • 專案簡介(1-2 句)。
  • 需求與安裝步驟。
  • 如何執行、測試與建置 — 需提供可直接複製貼上的命令。
  • 設定:每個環境變數的用途與範例值(絕不能包含真實機密)。
  • 主要功能的簡短使用範例。

規則:

  • 僅編輯受變更影響的區塊,不要重寫整個檔案。
  • 確認你記錄的每個命令確實可執行。
  • 使用英文,句子簡短,不使用行銷語言。

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

相關技能