Skip to content

rdcrystallab/build-standalone-html-report

v1.0.0MIT

建立與修訂自包含的單檔 HTML 研究、事故、架構比較與決策報告,內建編輯方法、視覺規範、範本與驗證工具。

Build Standalone HTML Report

把研究素材、量測結果、repository 證據或事故時間線整理成可獨立開啟、可驗證、可供決策的單檔 HTML 報告。

適用情境

  • 研究報告與技術選型比較
  • 事故調查與 post-mortem
  • 架構比較與決策摘要
  • 原始量測資料的視覺化與證據整理
  • 依瀏覽器預覽註解反覆修訂既有報告

內含資源

  • SKILL.md:從證據、論述、版面到交付的完整工作流程
  • assets/report-template.html:預設 light theme 的自包含 HTML 範本
  • references/editorial-method.md:研究、比較與事故報告的編輯方法
  • references/visual-system.md:表格、圖表、架構圖與互動元件規範
  • references/quartz-publishing.md:Quartz 環境的發佈注意事項
  • scripts/validate_report.py:單檔 HTML 結構、連結、可攜性與無障礙檢查

使用方式

直接要求 agent 使用 build-standalone-html-report skill,例如:

把這些 PostgreSQL HA 比較結果整理成一份單檔 HTML 研究報告,包含架構圖與 footprint 圖表。

驗證產出的報告:

python3 skills/build-standalone-html-report/scripts/validate_report.py path/to/report.html

新報告可加上 --strict-warnings;CI 可使用 --format json 取得結構化結果。

設計原則

  • 結論與影響優先,避免把調查過程直接堆進成品
  • 明確區分觀察事實、推論、未知與限制
  • 精確數字需附量測方法、時間窗、單位與原始證據
  • 圖表只呈現真正需要視覺化的關係
  • HTML 不依賴外部 CSS 或 JavaScript,預設淺色、支援窄螢幕與列印
  • 交付前必須實際 render、操作並驗證,不只檢查原始碼