Skip to content

v1.4.3 (Query Feature Documentation Consistency Sweep)

Choose a tag to compare

@chinglin-k chinglin-k released this 22 Aug 13:15
· 30 commits to main since this release

v1.4.3 - Query Feature Documentation Consistency Sweep

本版本針對「查詢案件」功能(於 v1.4.0 新增)在各文件頂層總覽與摘要章節是否同步更新,進行了全庫的精確掃描與修正。確保所有架構圖、計數摘要與系統角色描述皆與實際程式碼行為完全一致。

This release focuses on a comprehensive codebase scan and correction of the "Query Report" feature (introduced in v1.4.0) across all high-level overview and summary sections in the documentation. It ensures that all architecture diagrams, counter summaries, and system role descriptions are perfectly synchronized with the actual codebase behavior.


📄 文件正確性修復 (Documentation Correctness Fixes)

  • [BUG-41] 系統架構概覽圖修正 (System Architecture Diagram Update)

    • ZH: 修正了 doc/architecture.md 中 §1 的頂層系統架構圖(Mermaid)。原本 GAS -> Sheet 的資料流箭頭僅標示「報修寫入」,現已精確補上 queryReport() 實際執行「學號比對後讀取」的查詢行為,使頂層架構圖與 §4.4 的細節資料流描述保持一致。
    • EN: Updated the top-level system architecture diagram (Mermaid) in §1 of doc/architecture.md. The data flow arrow for GAS -> Sheet previously only indicated "report writing". It has now been accurately updated to include the query behavior of queryReport() (reading after student ID matching), ensuring consistency with the detailed data flow description in §4.4.
  • [BUG-42] 端點計數自相矛盾修正 (Correction of Contradictory Endpoint Counts)

    • ZH: 修正了 README.md 功能特色章節中的計數矛盾。原先宣稱雙層流量限制僅涵蓋四個端點(漏列 query),現已更正為「五個端點」(包含 classify、report、query、counter_get、counter_increment),使其與同份文件下方的「已知安全性說明」表格完全吻合。
    • EN: Fixed a contradictory endpoint count in the features section of README.md. The text originally claimed the dual-layer rate limiting covered only four endpoints (omitting query). It has been corrected to "five endpoints" (including classify, report, query, counter_get, and counter_increment), perfectly aligning with the "Known Security Implementations" table further down in the same document.
  • [BUG-43] 補齊系統角色與背景描述 (Completion of System Roles and Background Descriptions)

    • ZH: 在 doc/requirements.md 的 §1 專案背景與 §2 系統角色說明中,除了原有的「教學查詢與發起報修」外,正式補上了「查詢自己的報修案件進度」的描述。確保了 v1.4.0 的核心查詢功能在頂層需求總覽中不再缺席。
    • EN: In §1 Project Background and §2 System Roles of doc/requirements.md, the ability to "query the progress of one's own repair requests" was formally added alongside the existing tutorial lookup and report submission features. This ensures the core query functionality introduced in v1.4.0 is no longer absent from the top-level requirements overview.

✅ 本次掃描確認無問題的項目 (Verified Clean — No Action Needed)

  • ZH: 其餘文件包含 doc/data-model.md、doc/project-memory.md、doc/todo.md 以及 AGENTS.md,經查驗皆已正確涵蓋查詢功能,未發現同類疏漏。全數 53 項單元測試與 ESLint 檢查均維持 100% 通過。
  • EN: Other documents, including doc/data-model.md, doc/project-memory.md, doc/todo.md, and AGENTS.md, were verified to correctly cover the query feature with no similar omissions found. All 53 unit tests and ESLint checks remain 100% passing.