
Documenting Legacy Codebases
作者 riekelt85e53729dd95無授權條款28 個星標收錄於 2026年10月8日更新於 2026年10月8日儲存庫3 週前更新
Use when documenting an existing codebase whose documentation is missing, stale, or untrusted - an inherited system, a legacy application, a repo where the docs lie - or when regrounding a documentation tree against the code, or when someone asks what a system actually does. Encodes the survey-first inventory, the writer-side evidence hierarchy, depth-per-surface rules, the refactor test, dead-or-alive proofs, the quirks-and-findings split, the coverage ledger, the parallel campaign, and the docs-tree skeleton. Use whenever documentation must be reconstructed from the code rather than written alongside a change.
- 85e53729dd95目前提交 85e5372發布於 2026年10月8日
來源與署名
來源:riekelt/technical-writer位於plugins/technical-writer/skills/documenting-legacy-codebases提交85e5372
授權條款: 無授權條款
內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。
更多來自 riekelt/technical-writer 的技能

Writing Runbooks
riekelt
指導撰寫供人在時間壓力下執行的操作手冊、安裝、發佈、遷移與棄用流程文件。

Writing Postmortems
riekelt
指導撰寫不究責的事後檢討、事故報告與根因分析,包含以證據為基礎的時間軸與有歸屬的待辦事項。

Writing Issues
riekelt
指導撰寫追蹤系統中的議題,例如史詩、故事、任務、缺陷與調查,並提供可測試的驗收標準。

Writing Design Docs
riekelt
指導撰寫提案、RFC、設計文件、規格與遷移計畫,提供固定骨架與完整性檢查。

Writing Changelogs
riekelt
指導撰寫變更日誌條目、發行說明與交接摘要,規範條目結構與誠實性慣例。

Technical Writing
riekelt
用於撰寫、重整與修訂技術文件(如規格、設計文件、README)的內部風格與真實性規則。
更多Software Development技能

Playground
anthropics
建立自成一體的互動式 HTML 遊樂場,包含控制項、即時預覽與可複製的提示詞輸出。

M5 Onboard
anthropics
透過 USB 偵測 M5Stack ESP32 開發板,燒錄 UIFlow 2.0 韌體並安裝 MicroPython 應用程式套件。

Cardputer Buddy
anthropics
指導迭代 Cardputer-Adv 的 MicroPython 應用程式套件:新增應用程式、透過 USB 序列埠推送檔案、查看日誌並執行 REPL 指令。

Web Design Guidelines
vercel-labs
依據從遠端來源取得的 Web Interface Guidelines 審查 UI 程式碼,並以 file:line 形式回報問題。

Vercel React Native Skills
vercel-labs
React Native 與 Expo 最佳實務規則,涵蓋清單效能、動畫、導覽、UI 模式、狀態與 monorepo 設定。

Vercel React Best Practices
vercel-labs
Vercel 的 React 與 Next.js 效能指南,以 70 條規則的形式用於撰寫、審查與重構程式碼。