agentleFS
u9401066u9401066/asset-aware-mcp/.claude/skills/readme-updater/SKILL.md

readme-updater

Skill0 starsChanged 7 months agoApache-2.0View on GitHub

Intelligently update README.md to sync with code changes. Triggers: readme, 說明, 更新說明, update readme, 文檔同步.

9 other projects use a version of this, 3 of them edited.

Adopted by

Most recently taken up by

The file

Files
SKILL.md

README 更新技能

描述

智能更新 README.md,保持與程式碼同步。

觸發條件

  • 「更新 README」
  • 被 git-precommit 編排器調用
  • 新增重要功能後

法規依據

  • 憲法:CONSTITUTION.md 第 6 條

更新策略

1. 偵測變更類型

  • 新功能 → 更新功能列表
  • 新依賴 → 更新安裝說明
  • API 變更 → 更新使用範例
  • 結構變更 → 更新專案結構

2. 更新區塊

區塊條件
功能列表新增/移除功能
安裝說明依賴變更
使用範例API 變更
專案結構目錄結構變更
配置說明新增設定選項

3. 保持區塊

以下區塊不自動修改:

  • 授權資訊
  • 貢獻指南
  • 致謝

輸出格式

📝 README 更新分析

變更偵測:
  ✅ 新增功能:用戶認證模組
  ✅ 新增依賴:bcrypt

建議更新:
  [功能列表] 新增「🔐 用戶認證」
  [安裝說明] 新增 bcrypt 安裝指令

預覽:
  ## 功能
  - 🤖 Claude Skills
  - 📝 Memory Bank
+ - 🔐 用戶認證(新增)

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.