github-release-assistant
生成雙語 GitHub 版本發布文檔
創建精美的版本發布文檔需要時間,且需要跨語言的一致性。此技能可根據您現有的倉庫元數據自動生成雙語 README。
下載技能 ZIP
在 Claude 中上傳
前往 設定 → 功能 → 技能 → 上傳技能
開啟並開始使用
測試它
正在使用「github-release-assistant」。 包含 config.json 的倉庫,其中有項目元數據和 requirements.txt 文件
預期結果:
創建兩個文件:README.md(英文)和 README.zh.md(中文),具有匹配的結構,包括項目概述、主要功能、快速開始說明和授權徽章
正在使用「github-release-assistant」。 在現有文檔上使用 --language both --overwrite 標誌運行生成器
預期結果:
更新的 README 文件替換先前版本,同時通過暫存的更改保留 git 歷史記錄,供審查使用
安全審計
安全Static analysis flagged 53 patterns but all are false positives. The 'weak cryptographic algorithm' warnings match MATLAB function names (BDF1, BDF2, ode45) in documentation, not actual crypto code. 'Ruby backtick execution' is Python code with markdown documentation formatting. Hardcoded URLs are standard badge images from shields.io. Unicode regex detects CJK characters for bilingual support. No malicious intent, no credential handling, no external API calls beyond static badge URLs.
品質評分
你能建構什麼
開源項目維護者
為每個 GitHub 版本發布生成一致的雙語發布文檔,無需手動編寫兩個語言版本。
國際開發者
為面向國內和國際受眾的項目快速創建中文和英文 README 文件。
研究代碼分發
為學術軟件發布生成專業文檔,包含清晰的章節結構和安裝說明。
試試這些提示
使用默認模板為我的倉庫生成雙語 README 文件。
使用 release_assistant.json 中的設置創建 README.md 和 README.zh.md,包含項目名稱、功能和快速開始步驟。
僅生成中文 README(README.zh.md),使用現有項目元數據,如果文件存在則覆蓋。
生成兩個 README 文件,向我顯示 git diff,然後引導我使用合適的提交消息完成提交和推送更改。
最佳實務
- 在提交之前審查生成的 README 內容,以確保提取的元數據準確
- 創建 release_assistant.json 並包含自定義項目詳情,以便跨版本保持一致的輸出
- 在運行 git add 和 commit 操作之前使用 git diff 預覽更改
避免
- 不要在不審查提取內容準確性的情況下提交生成的 README 文件
- 除非打算完全替換現有文檔,否則避免使用 --overwrite 標誌
- 在首先驗證 diff 僅顯示預期的文檔更改之前,不要運行 git push