Git 文檔自動更新技能

git-doc-updater

Auto-check and update key documentation before Git commits to keep docs in sync with code. Triggers: docs, 文檔, 更新文檔, sync docs, release, 發布, documentation, 同步文件, 文件檢查, doc check, 發布前, before release, 準備發布.

majiayu000/claude-skill-registry-data·0installs23starsSecurity

SKILL.md

Full skill instructions

Git 文檔自動更新技能

描述

在執行 Git commit 之前，自動檢查並更新專案的關鍵文檔，確保文檔與程式碼保持同步。

觸發條件

當用戶要求進行以下操作時啟用此技能：

Git commit
Git push
提交程式碼
準備發布

自動更新的文檔

1. README.md

更新專案描述（如有變更）
更新安裝/使用說明
更新功能列表
更新依賴項目

2. CHANGELOG.md

根據本次變更添加新條目
遵循 Keep a Changelog 格式
分類為：Added, Changed, Deprecated, Removed, Fixed, Security
包含日期和版本號（如適用）

3. ROADMAP.md

標記已完成的功能項目
更新進行中的項目狀態
調整優先順序（如需要）

4. ARCHITECTURE.md (ARCH)

更新架構圖和說明（如有結構性變更）
更新組件關係
更新技術決策記錄

5. Memory Bank 文件

更新 memory-bank/ 目錄下的相關文件：

activeContext.md - 當前工作焦點
progress.md - 進度追蹤（Done/Doing/Next）
decisionLog.md - 記錄重要決策
productContext.md - 專案上下文（如有變更）

執行流程

1. 分析本次程式碼變更內容
2. 識別哪些文檔需要更新
3. 依序更新各文檔
4. 顯示更新摘要供用戶確認
5. 將文檔變更加入 Git staging

更新原則

最小變更：只更新與本次提交相關的內容
保持一致性：維持現有文檔格式和風格
自動摘要：從 commit 內容推斷變更摘要
版本控制：CHANGELOG 使用語義化版本

範例輸出

當用戶說「準備 commit」時：

📝 文檔更新檢查：

✅ README.md - 無需更新
✅ CHANGELOG.md - 已添加 v1.2.0 條目
✅ ROADMAP.md - 已標記「用戶認證」為完成
⏭️ ARCHITECTURE.md - 無結構性變更，跳過
✅ memory-bank/progress.md - 已更新進度

準備提交以下文件變更...

自定義選項

用戶可以透過提示指定：

--skip-readme 跳過 README 更新
--skip-changelog 跳過 CHANGELOG 更新
--skip-memory 跳過 Memory Bank 更新
--dry-run 只顯示將要更新的內容，不實際修改

Install skill

Copy and run in your terminal

npx -y skills add https://github.com/majiayu000/claude-skill-registry-data --skill git-doc-updater

View on GitHub

data/git-doc-updater/SKILL.md

More Security skills

View all

Security

supabase

Handles the full Supabase workflow from schema changes to deployment, with built-in security guardrails that catch common traps like RLS...

2.7K 308.9K

View

Security

neon-postgres

Comprehensive guides and best practices for Neon Serverless Postgres, covering setup, connection methods, authentication, and platform APIs.

98 216.2K

View

Security

firebase-auth-basics

Guide for setting up and using Firebase Authentication. Use this skill when the user's app requires user sign-in, user management, or secure data access using auth rules.

462 163.8K

View

Security

firebase-security-rules-auditor

A skill to evaluate how secure Firestore security rules are. Use this when Firestore security rules are updated to ensure that the generated rules are extremely secure and robust.

462 127.7K

View

Security

firebase-ai-logic-basics

Official skill for integrating Firebase AI Logic (Gemini API) into web applications. Covers setup, multimodal inference, structured output, and security.

462 125.1K

View

Security

better-auth-best-practices

Complete Better Auth server and client setup with database adapters, session management, plugins, and security configuration.

222 118.2K

View

Security

vercel-cli-with-tokens

Deploy and manage projects on Vercel using token-based authentication. Use when working with Vercel CLI using access tokens rather than interactive login — e.g. "deploy to vercel", "set up vercel", "add environment variables to vercel".

31.9K 116.1K

View

Security

cloudflare

Complete Cloudflare platform integration with decision trees for compute, storage, AI, networking, security, and infrastructure-as-code.

3K 110.7K

View

Security

azure-compliance

Run Azure compliance and security audits with azqr plus Key Vault expiration checks. Covers best-practice assessment, resource review, policy/compliance validation, and security posture checks. WHEN: compliance scan, security audit, BEFORE running azqr (compliance cli tool), Azure best practices, Key Vault expiration check, expired certificates, expiring secrets, orphaned resources, compliance assessment.

253 103K

View