Community寫作與編輯github.com

gener8v/gener8v.claude-skills.engineering

建立或補足專案的說明文件集:列出現有文件,讓使用者選擇要新增的類型,從程式碼中收集共用的事實表,然後撰寫文件(若有多份則平行進行),最後互相檢查並與程式碼比對。

gener8v.claude-skills.engineering 是什麼?

此技能用於一次性大規模初始化或補足專案的說明文件集。它會先盤點現有文件(如 README、ARCHITECTURE 等),並標記其狀態(存在、薄弱或缺失),然後讓使用者選擇要撰寫的文件類型。在撰寫前,它會從程式碼與 Git 歷史中收集一個共用的事實表(fact sheet),確保所有文件使用一致的資訊。撰寫時,若文件超過三份,會啟用子代理來平行處理;最後會執行一致性檢查並提交 PR。支援 Claude Code、Cursor 等工具,適用於「bootstrap the docs」或「缺少 README」這類任務,但不用於後續的增量更新。

相容平台✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/gener8v/gener8v.claude-skills.engineering/tree/HEAD/skills/documentation-bootstrap

Installed? Explore more 寫作與編輯 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

文件初始化

這是一次性的大規模任務。在此之後的變更,請使用 engineering:documentation-sync。

1. 盤點

列出現有的文件,並將每份標記為 存在、薄弱(存在但幾乎空白或過期)或 缺失。至少檢查以下項目:

README.md、CONTRIBUTING.md、CHANGELOG.md、ARCHITECTURE.md 或 docs/architecture/、決策記錄、CLAUDE.md、SECURITY.md、LICENSE、API 參考、配置參考、runbook。

git ls-files '*.md' | grep -v node_modules

2. 讓使用者選擇

顯示來自 resources/doc-catalog.md 的選單。將每種類型標記為存在、薄弱或缺失。標記你推薦用於此類專案的類型。

  • 已存在的文件不會重寫。使用者可以為薄弱文件選擇「修訂」。
  • 由使用者挑選。不要撰寫使用者未選擇的類型。

3. 建立事實表

在任何人開始撰寫之前,先收集多份文件都會用到的事實。從程式碼與 git 中取得,而不是憑記憶。將它們寫入一個暫存檔案。

事實來源
專案名稱與一句話目的README、manifest、使用者
當前版本manifest、最新標籤(git describe --tags --abbrev=0)
語言、框架及其版本manifest 與鎖定檔案
安裝、測試、lint、建置與執行命令engineering:development-commands
元件及其名稱目錄佈局、進入點、compose 檔案
環境變數與設定.env.example,以及讀取設定的程式碼(搜尋 process.env、os.environ、getenv)
重要日期第一個提交(git log --reverse)、標籤
目前可運作與不可運作的部分使用者、未解決的 issue

如果兩個來源不一致,請詢問使用者。不要靜默選擇其中一個。每位作者只使用事實表與程式碼。

4. 撰寫

  • 三份文件或更少: 親自依序撰寫。
  • 超過三份: 為每份文件或小組啟動一個子代理,一次最多四個。每個子代理需獲得:
    • 它負責的具體檔案,以及不得更改任何其他檔案的規則;
    • 事實表;
    • 來自 resources/doc-catalog.md 中其類型的章節大綱;
    • 使用簡化技術英語撰寫的指示(若已安裝 simple-english 技能);
    • 報告它需要但未找到的事實,而不是憑空編造。

請勿編造歷史、數字、使用者或功能。寫「TBD」並將其列出供使用者處理。

5. 檢查文件集

遵循 resources/consistency-check.md。修復所有問題後再繼續。

6. 提交

將文件放到一個分支上(engineering:git-branching)並開啟 PR(engineering:github-pr-merge)。在 PR 主體中,列出每份新文件以及每個需要使用者回答的「TBD」。

相關技能

  • engineering:documentation-sync:在此之後維護這些文件的正確性。
  • gener8v:brownfield:將現有程式碼庫導入 gener8v 管道。它會寫入 .gener8v/ 上下文,而非這些專案文件。

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

gener8v/gener8v.claude-skills.engineering

Find and run a project's test, lint, type-check, build and dev-server commands, read the results correctly, and seed a throwaway database when UI work needs realistic data. Never seeds the project's real or default database. Use before 'run the tests', 'lint this', 'does it build', 'start the app so I can see it', 'seed some demo data', and before you claim that a change works. Not for deployment or CI pipeline design; use the project's own deploy tooling for those.

gener8v/gener8v.claude-skills.engineering

Before a commit, find every document that describes what the change touched and update it in the same commit, or confirm in one line that no document needs a change. Catches stale text, missing documentation and facts kept in two places. Use before any commit or PR, and when asked 'are the docs up to date', 'update the docs for this change' or 'did I miss a README change'. Not for creating a documentation set or filling large gaps (documentation-bootstrap), and not for gener8v pipeline documents under .gener8v/, which the pipeline skills own.

gener8v/gener8v.claude-skills.engineering

Put work on the correct branch before the first edit. Finds the base branch, starts a well-named branch from the current remote tip, and sets up one worktree per agent for parallel work. Use at the start of any change to a tracked file, such as 'start on issue 42', 'fix this typo', 'set up branches for these three tickets', or before you start sub-agents that edit code. Not for opening or merging a PR (github-pr-merge) or for history rewrites and other risky git commands (git-safety).

gener8v/gener8v.claude-skills.engineering

Approval gate for git commands that destroy work or skip checks: force-push, --no-verify, signing bypass, reset --hard, clean -f, discarding uncommitted edits, branch or tag deletion, rewriting pushed commits and push --mirror. Each one needs the user's explicit approval at that moment; an earlier approval never carries over. Also covers a secrets check before a commit and what to do when a secret is already committed. Use before any of these commands, or when asked to 'force push', 'skip the hooks', 'throw away my changes' or 'delete that branch'. Not for normal branching (git-branching) or the PR flow (github-pr-merge).

相關技能