Skip to content

Repository files navigation

vChewing & LibVanguard 工作區 - DevLogs

本倉庫是 vChewing 專案的跨倉開發記錄,收納原位於 vChewing-LibVanguard/DevPlans/ 的全部內容,現供整個 vChewing 組織跨倉使用——vChewing-macOS、vChewing-OSX-Legacy、vChewing-LibVanguard、vChewing-VanguardLexicon 等倉的 Phase 手術都記在這裡。

vChewing 輸入法在「威注音時代(v4.1.2 版為止)」是以人力為主完成開發的。v4.1.3 版起屬於「唯音時代」,利用 LLM 提升開發效率。為了保證相關修改內容有據可查、便於之後的 LLM 工作或人力工作能夠了解情況,故整理此倉庫。

目錄結構

vChewing-DevLogs/
├── KnowledgeMemo4LLM.md       # 架構知識 + 給 AI Agent 的 Response Pattern(開工前必讀)
├── DevReqsHistory.md          # 逐 Phase 開發史摘要
├── Reqs4LLM/                  # Phase 需求書與實作記錄
│   ├── Reqs_Other_Pending_Phases.md
│   ├── Archive_P001-P100/     # 已凍結(Phase 01~100 收齊)
│   ├── Archive_P101-P200/     # 已凍結(Phase 101~200 收齊)
│   └── Archive_P201-P300/     # 未凍結;內含現行卷(檔名現算,見 KnowledgeMemo4LLM.md 文首〈Reqs4LLM 分卷歸檔註記〉)
├── Research/                  # 各 Phase 的研究報告
└── PendingFeatureReqs/        # FeatureRequest 類 PreResearch

使用方式

  • 文書之寫作紀律(House Style):見 KnowledgeMemo4LLM.md §12.7——一處一寫(durable 事實入 KnowledgeMemo4LLM.md、本 Phase 之證據入 Reqs 卷、索引入 DevReqsHistory.md、長篇推導入 Research/),並有篇幅預算與固定骨架。交差前跑一次 python3 Tools/housestyle_audit.py 檢核(超標須在回報中寫明理由)。Research/ 各檔不在此限。 適用起點為 P262;P241–P261 已於 2026-09-27 回溯套用(實績見 §12.7.6),以 python3 Tools/housestyle_audit.py --enforce-from 241 可複驗。注意:語言鐵律只管正文、不管引句——他語系(zh-Hans/ja/en)之出貨文案須逐字保留(§12.7.5 第 10 條)。
  • AI Agent:開工前先讀 KnowledgeMemo4LLM.md,尤其其中的〈Response Pattern〉與 §12 的文件更新規則。新 Phase 之記錄一律寫入現行卷(檔名現算、不以硬寫之檔名記載:取 Reqs4LLM/Archive_P*/ 之下標號最大的 Reqs_0NN1-0NN0.md,其 ^# Phase 標題數未達 10 者即為現行卷;判定式見 KnowledgeMemo4LLM.md 文首〈Reqs4LLM 分卷歸檔註記〉);已滿或已結案的歸檔卷不再增改——但對過往 Phase 之補記不在此限:無論該卷是否已歸檔,補記一律補進那個 Phase 自己的記錄內,不得佔用其他 Phase(含現行卷)的記錄空間。
  • 人類讀者:DevReqsHistory.md 是最快的入口(逐 Phase 一行摘要),要細節再進 Reqs4LLM/ 或 Research/。

慣例

  • 本倉庫所有文件內的路徑一律以工作區根為錨(vChewing-DevLogs/…、vChewing-LibVanguard/…、vChewing-macOS/…)。
  • 文書以繁體中文(zh-Hant)撰寫。
  • 臨時檔案請放倉庫根目錄的 tmp/ 或 .tmp/(已 gitignore),勿用系統的 /tmp/。
  • 分卷以「十年前綴 0NN1–0NN0」為界、每卷至多 10 個 Phase(如 Reqs_0201-0210.md 收 Phase 201~210),一律置於 Archive_P{首 Phase 所屬百位段}/ 之下——該目錄同時容納尚在續寫的現行卷與已結案的歸檔卷。同一區間內的新 Phase 續寫同一卷,不另立新卷;卷滿或經事主裁定結案後,該卷不再增改——惟對該卷內某個 Phase 之補記仍逕補進那個 Phase 自己的記錄內(見上〈使用方式〉)。
  • 「凍結」的定義:Archive_P…/ 桶要收齊該百位段的 100 個 Phase 才稱「凍結」;未滿 100 個 Phase 者只稱「已歸檔」,該桶仍會續收後續結案的分卷(現下的 Archive_P201-P300/ 即屬後者)。

授權

本倉庫自身內容以 LGPL-3.0-or-later 授權,詳見 COPYING 與 LICENSES/preferred/LGPL-3.0-or-later。

倉內引用的程式碼與資料仍依其來源授權,不受本倉庫授權影響:

來源 授權
vChewing-LibVanguard LGPL-3.0-or-later(附 Swift 靜態連結例外)
vChewing-macOS/vChewing-OSX-Legacy MulanPSLv2
vChewing-VanguardLexicon MulanPSLv2(語料編譯器)
vChewing-Homebrew AGPL-3.0

另有引自 ButKo BPMFVS 等第三方專案的片段,各依其原始授權,請洽各自上游。

About

The Dev Logs of vChewing IME since v4.1.3 (唯音) era.

Resources

Code of conduct

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages