生產力
sync-readme avatar

sync-readme

同步 README.md 與 README_ZH.md 檔案內容,確保中英文說明文件內容一致且架構對齊。

簡介

sync-readme 技能專為維護中英文雙語文件專案的開發者所設計。透過自動比對 README.md 與 README_ZH.md,此工具能偵測兩者之間的差異、新增區段或過時內容,確保文件內容保持同步且一致。此技能對於使用 ai-rules-sync 或類似軟體專案的開發人員特別有幫助,能有效降低維護多語言文件的技術負擔。

  • 自動判定更新時間點,選擇正確的同步方向(從英文同步至中文,或反之)。

  • 精確保留技術規格中的程式碼區塊、語言標章、表格結構以及內部的連結格式。

  • 強制執行技術詞彙的統一性,例如將 rules 翻譯為「規則」、commands 為「命令」、skills 為「技能」、agents 為「代理」、instructions 為「指令」等。

  • 維持標題層級與結構的一致性,確保使用者在切換語言時能擁有順暢的閱讀體驗。

  • 驗證文件完整性,確保兩份檔案中的功能說明、設定範例以及工具對照表皆完全匹配。

  • 此技能假設儲存庫根目錄下同時存在 README.md 與 README_ZH.md 兩個檔案。

  • 若雙方檔案皆有衝突性的更新,系統會提示使用者確認何者為唯一的真理來源。

  • 建議在完成重大功能更新或文件重構後執行此技能。

  • 輸入為標準 GitHub Markdown 格式,輸出為自動更新後的在地化文件。

  • 注意程式碼範例維持不變,僅針對敘述性文字與介面術語進行翻譯,以確保文件具備專業且一致的技術表達標準。

倉庫統計

Star 數
27
Fork 數
1
Open Issue 數
2
主要語言
TypeScript
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月3日 下午06:39
在 GitHub 查看