OdfKit 文件中心
歡迎來到 OdfKit 文件中心。您可以依照目前的工作階段,從評估、導入到營運與驗證, 快速找到需要的資訊;若是第一次使用,建議先從快速開始與套件選型著手。
建議閱讀路徑
| 如果您要… | 建議先讀 | 再延伸閱讀 |
|---|---|---|
| 快速評估 OdfKit 是否符合需求 | README | ODF 規範支援邊界、套件目錄與選型指南、ODF 格式支援矩陣、效能對比報告、智慧財產與合規說明 |
| 決定要安裝哪些套件 | 套件目錄與選型指南 | NuGet 相容矩陣、渲染後端部署 |
| 建立第一個範例或驗證 PoC | 快速開始、核心 SDK 快速開始 | 實作食譜、範例總覽 |
| 了解內建 Profile 與多語系機制 | ODF Profile 來源 | i18n 與在地化、i18n 詞彙表、ODF 格式支援矩陣 |
| 規劃部署、升級與版本交付 | 版本與交付資訊 | 高階 API 遷移指南、GitHub Release 發佈指南、CHANGELOG |
| 確認功能邊界、互通性與驗證證據 | 能力宣稱與證據索引 | ODF 格式支援矩陣、WebFont 證據矩陣、LibreOffice 互通矩陣、OOXML 視覺驗收矩陣 |
| 維護 CI/CD 與驗證分層 | CI/CD 驗證設計 | GitHub Release 發佈指南、Corpus Manifest 規則 |
依生命週期分類
1. 評估與決策
| 文件 | 用途 |
|---|---|
| README | 產品概觀、安裝入口、文件導覽 |
| 套件目錄與選型指南 | 依情境挑選核心套件、擴充套件與工具 |
| NuGet 相容矩陣 | 套件清單、目標框架、安裝策略 |
| ODF 格式支援矩陣 | 功能覆蓋、狀態標記與測試證據 |
| ODF 規範支援邊界 | ODF 1.0~1.4 各規格層、支援深度與刻意排除項目 |
| ODF Profile 來源 | 內建 Profile 的來源、權威層級與驗證狀態 |
| i18n 與在地化 | 語系字典、訊息遞補與 OdfLocalizer 使用方式 |
| 版本與交付資訊 | 交付管道、版本原則與安裝參考 |
2. 導入與開發
| 文件 | 用途 |
|---|---|
| 快速開始 | 第一個專案、第一個文件、CLI 驗證 |
| 核心 SDK 快速開始 | 核心 SDK 的純受控建立、載入、驗證與低記憶體匯出路徑 |
| ODF 指令碼與巨集管理 | ODF 1.0~1.4 script/event CRUD、LibreOffice 巨集簽章、信任政策、結構式診斷與安全邊界 |
| 實作食譜 | 常見操作片段與實作範例 |
| WebFont 多國罕用字套件 | ASP.NET Core/Web Forms、CSP、CDN、自動內容掃描、Big5/Big5E 與 ORM 整合 |
| WebFont Sidecar 部署與維運 | Windows Server、IIS Express、非 Windows 平台、程序生命週期、監控與升級回復 |
| NativeAOT 支援與部署邊界 | 核心 AOT 證據、套件矩陣與 net48 WOFF2 sidecar 部署 |
| WebFont 純 .NET 架構契約 | 純 C#/.NET 產品邊界、格式與授權準入、Phase 0~5 驗收 |
| API 表面分層 | API 分層、使用路徑與新增 API 放置準則 |
| API 表面一致性 | 公開 API 分層、命名契約與非目標邊界 |
| API 表面盤點 | 高階外觀層命名判讀、破壞性重新命名批次與文件掃描基線 |
| API Reference | Spreadsheet、Chart、Template 與 Interop 的 options、report 與能力邊界 |
| 高階 API 遷移指南 | 從早期 0.0.1 草稿遷移至四主格式一致生命週期契約 |
| NPOI/Independentsoft 遷移指南 | 從常見第三方文件 API 遷移至 OdfKit 的對照與注意事項 |
| 串流讀取安全限制 | ODS/ODT Reader 的資源預算、資料流所有權與信任邊界 |
| 工具總覽 | CLI、schema generator、corpus generator 與 trim smoke 工具總覽 |
| 範例總覽 | 單檔 Script 範例與輸出說明 |
| 渲染後端部署 | LibreOffice 渲染擴充的部署要求 |
| Foreign 擴充政策 | 非標準命名空間與相容策略 |
| UDX 非功能性目標 | 明確排除於實作範圍外的功能模組與非目標 |
3. 驗證、互通與營運
| 文件 | 用途 |
|---|---|
| ODF Toolkit 對標線 | ODF Toolkit / ODF Validator / ODFDOM 對標狀態 |
| LibreOffice 互通矩陣 | 與 LibreOffice 的行為驗證 |
| OOXML 視覺驗收矩陣 | OOXML 視覺與 golden 驗收 |
| 互通語料庫總覽 | corpus 來源與使用方式 |
| 官方 Corpus 來源 | 官方 ODF corpus 來源說明 |
| Corpus Manifest 規則 | corpus manifest 契約 |
| CI/CD 驗證設計 | GitHub Actions 分層、逾時、煙霧測試與診斷產物規則 |
| API 文件網站治理 | DocFX 輸入、建置、連結檢查與發布邊界 |
| 能力宣稱與證據索引 | 將公開能力宣稱對應至測試、規格與可重現證據 |
| WebFont 證據矩陣 | WebFont Phase 0~5 的已實證能力、實驗性功能與人工閘門 |
| WebFont 純 .NET 架構契約 | managed 引擎的實作順序、拒絕矩陣與 clean consumer 證據 |
| 可維護性與複雜度債 | Partial、在地化 JSON 產線、Public API、Package Validation |
| 協作者地圖 | 大型領域根與 partial/engine 邊界(v0.0.1 完滿基線) |
| 人機協作可維護性 | 人類/Agent 平衡;禁止為拆而拆 |
| 公開 API 可選參數規範 | RS0026/RS0027、CancellationToken 公開/內部政策與新增 API 檢查清單 |
| 產品品質閘門 | Corpus/LibreOffice/OOXML/效能基線與 sample 可執行檢查入口 |
| 效能預算 | CI 效能門檻、回歸判定與預算設定檔的維護原則 |
| 效能基準線 | 基準測試回歸關卡、穩定量測設定檔與基準線報告產生方式 |
| 三格式標準效能基準 | ODS、ODT、ODP 標準工作負載、checksum 與量測政策 |
| 效能對比報告 | OdsStreamWriter 與 MiniExcel、ClosedXML 之跨套件串流寫入實測對比、方法論限制與授權裁定 |
| GitHub Release 發佈指南 | 封裝、驗證與發佈步驟 |
| ODF 1.4 逐章稽核紀錄 | 對照 ODF 1.4 四份正式規格文本逐章比對 schema/驗證層/公式引擎缺口 |
| ODF 1.4 規格覆蓋契約 | Schema、package lifecycle、高階 facade 與互通行為的持續完滿定義 |
| ODF 1.4 覆蓋狀態 | 目前 coverage 摘要與持續驗收入口 |
其他治理文件
| 文件 | 用途 |
|---|---|
| Agent 按需開發指南 | 手寫 C#、XML 文件、測試與 Git 提交的條件式規範入口 |
| CHANGELOG | 版本變更與破壞性調整紀錄 |
| THIRD-PARTY-NOTICES | 第三方授權與版權聲明 |
| 來源與授權索引 | 模組來源、授權與依據 |
| Clean-room 來源索引 | 公式評估、schema pattern、JSON Collaboration 與受控轉換保真度的規格來源、不可複製來源與 golden 測試契約 |
| WebFont managed Clean-room 來源 | 字型 parser/writer 的允許規格、禁止實作來源與黑箱 oracle 隔離 |
| 智慧財產與合規說明 | 複合授權、AI 產製、clean-room、DCO、採用者盡職調查清單(非正式法律意見) |
| 可維護性與複雜度債 | Partial 準則、在地化拆分、產生碼、歷史腳本與後續債 |