스킬 post-impl-docs
📝

post-impl-docs

낮은 위험 📁 파일 시스템 액세스

保持文件與程式碼同步

文件常常會與程式碼變更脫節。此技能會自動更新 README、CHANGELOG、docs 資料夾和內聯文件字串,以反映已實作的變更。

지원: Claude Codex Code(CC)
⚠️ 67 나쁨
1

스킬 ZIP 다운로드

2

Claude에서 업로드

설정 → 기능 → 스킬 → 스킬 업로드로 이동

3

토글을 켜고 사용 시작

테스트해 보기

"post-impl-docs" 사용 중입니다. 執行 post-impl-docs 以在實作新的使用者驗證功能後更新文件

예상 결과:

文件更新成功:

README.md:
- 在功能部分新增「使用者驗證」
- 在 API 部分新增 `authenticate_user()`

CHANGELOG.md:
- 新增使用者驗證端點的 `feat:` 條目

文件字串:
- 更新了 3 個函數的文件字串

修改的檔案:5

"post-impl-docs" 사용 중입니다. 為變更錯誤處理行為的錯誤修復更新文件

예상 결과:

文件更新摘要:

CHANGELOG.md:
- 新增錯誤處理改進的 `fix:` 條目

文件字串:
- 更新了 2 個函數中 `ValueError` 異常的文件

README.md:無需變更(內部修復)
docs/:無受影響的參考

보안 감사

낮은 위험
v6 • 1/21/2026

Documentation skill containing cookbook reference material. All static findings are false positives - the skill contains markdown documentation with git command examples, changelog format references, and placeholder code blocks that triggered pattern matching but pose no security risk.

5
스캔된 파일
3,786
분석된 줄 수
1
발견 사항
6
총 감사 수
감사자: claude 감사 이력 보기 →

품질 점수

38
아키텍처
100
유지보수성
87
콘텐츠
19
커뮤니티
90
보안
83
사양 준수

만들 수 있는 것

維護準確的變更日誌

在實作功能或修復後,自動依照傳統提交標準新增正確格式化的變更日誌條目。

保持 README 同步

當新程式碼添加到程式碼庫時,更新 README.md 中的功能列表、API 部分和使用範例。

更新內聯文件

將文件字串與程式碼變更同步,以確保函數描述、參數和回傳值保持準確。

이 프롬프트를 사용해 보세요

基本文件更新
在最近的實作之後更新文件。分析 git diff 以了解變更內容。使用任何新功能更新 README.md,將變更日誌條目新增至 CHANGELOG.md,並更新已修改函數的文件字串。
重大變更文件
記錄重大變更。更新 README 遷移指南,在 CHANGELOG 中新增重大變更通知,更新所有受影響的文件字串,並標記 docs/ 資料夾中的文件以供審查。
API 新增文件
為新的 API 端點新增文件。更新 README API 部分,新增使用範例,為新函數建立文件字串,並新增相應的 CHANGELOG 條目。
完整文件審核
執行全面的文件審查。分析所有已變更的文件,更新對變更符號的 docs/ 參考,驗證文件字串的準確性,並產生完整的文件更新報告。

모범 사례

  • 在完成實作之後、提交之前執行此技能,以確保文件是最新的
  • 設定 CHANGELOG_FORMAT 變數以符合專案的變更日誌風格(傳統、keep-a-changelog 或簡單)
  • 設定 COMMIT_DOCS=true 以自動提交文件變更與程式碼

피하기

  • 在未先分析實際程式碼變更的情況下執行文件更新
  • 為像是拼寫錯誤修復之類的微小變更新增 CHANGELOG 條目
  • 在未驗證函數行為實際變更的情況下更新文件字串

자주 묻는 질문

此技能會建立新的文件檔案嗎?
不會。此技能會更新現有文件(README、CHANGELOG、docs/ 檔案、文件字串)。它不會從頭開始產生新文件。
支援哪些變更日誌格式?
支援三種格式:傳統(Angular 風格)、keep-a-changelog(Keep a Changelog 標準)和簡單(基本 markdown 清單)。
它會自動提交變更嗎?
設定 COMMIT_DOCS=true 來自動提交文件變更。預設為 true。變更會與程式碼分開提交。
如果沒有程式碼變更會怎麼樣?
此技能會分析 git diff。如果未偵測到變更,它會返回 no_changes 狀態,表示文件影響為無。
它可以更新任何程式語言的文件嗎?
可以。此技能可與任何語言配合使用。Python 和 TypeScript/JavaScript 的文件字串範本包含在 cookbook 中。
它如何知道要更新哪些文件?
它使用 grep 掃描 docs/ 資料夾以尋找對已變更函數/類別的參考,然後只更新受影響的文件。

개발자 세부 정보