wooo/awoooi
1
1
Fork 0
Code Issues 2 Pull Requests 1 Actions 5 Packages Projects Releases Wiki Activity
Files
e3bad588425c8a4805c033261a8ff96ebaf61ba8
awoooi/docs/TECHNICAL_DOCUMENTATION_CHECKLIST.md
OG T 7478dc0254 feat(phase6-9): Complete modular architecture and Agent Teams 
Phase 6.4 - Modular Architecture:
- Add lewooogo-brain adapters for LLM providers
- Add lewooogo-data dual memory (Redis + PostgreSQL)
- Implement consensus engine for multi-agent decisions
- Add incident memory service for historical context

Phase 9 - Agent Teams (Claude Agent SDK):
- Add base agent class with Claude Sonnet 4 integration
- Implement action planner, blast radius, and security agents
- Add agent API endpoints and proposal workflow
- Integrate ADR-009 OpenClaw Agent Teams architecture

DevOps & CI/CD:
- Add GitHub Actions CI/CD workflows (ci.yaml, cd.yaml)
- Add pre-commit hooks and secrets baseline
- Add docker-compose for local development
- Update Kubernetes network policies

Frontend Improvements:
- Add auto-healing error boundary component
- Update i18n messages for agent features
- Enhance dual-state incident card with execution feedback

Documentation:
- Add 7 ADRs covering MCP, design system, architecture decisions
- Update ARCHITECTURE_MEMORY.md with modular design
- Add GLOBAL_RULES.md and SOUL.md for project identity

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-03-23 18:40:36 +08:00

7.1 KiB
Raw Blame History

AWOOOI 技術文檔完整清單

版本: v1.0 建立日期: 2026-03-20 負責人: CTO 用途: 追蹤各團隊必須產出的技術文檔

文檔分類

類別 說明 主要負責人
ADR 架構決策記錄 CTO
SOP 標準作業程序 各單位
SPEC 技術規格文件 CTO / CPO
DIAGRAM 架構圖 / 流程圖 CTO / CIO
RUNBOOK 運維手冊 CIO
SECURITY 安全文檔 CISO

CTO 必須產出文檔

架構決策記錄 (ADR)

ID 文檔名稱 狀態 路徑
ADR-001 MCP Protocol 採用 ✅ docs/adr/ADR-001-mcp-protocol-adoption.md
ADR-002 Nothing.tech 設計系統 ✅ docs/adr/ADR-002-nothing-tech-design-system.md
ADR-003 leWOOOgo 模組架構 ✅ docs/adr/ADR-003-lewooogo-module-architecture.md
ADR-004 Zustand 狀態管理 ✅ docs/adr/ADR-004-state-management.md
ADR-005 BFF 閘道架構 ✅ docs/adr/ADR-005-bff-architecture.md
ADR-006 AI 降級備援策略 ⏳ docs/adr/ADR-006-ai-fallback-strategy.md
ADR-007 資料保留策略 ⏳ docs/adr/ADR-007-data-retention-policy.md

技術規格 (SPEC)

ID 文檔名稱 狀態 路徑
SPEC-001 API 開發 SOP ✅ docs/api/API_DEVELOPMENT_SOP.md
SPEC-002 OpenAPI 規格 ✅ docs/api/api-contract.yaml
SPEC-003 SSE 串流規格 ⏳ docs/api/SSE_SPECIFICATION.md
SPEC-004 快取策略規格 ⏳ docs/api/CACHE_STRATEGY.md
SPEC-005 資料庫 Schema ⏳ docs/database/SCHEMA.md

架構圖 (DIAGRAM)

ID 圖表名稱 狀態 路徑
DIAG-001 系統架構總覽圖 ⏳ docs/diagrams/system-architecture.png
DIAG-002 資料流程圖 ⏳ docs/diagrams/data-flow.png
DIAG-003 API 序列圖 ⏳ docs/diagrams/api-sequence.png
DIAG-004 部署架構圖 ⏳ docs/diagrams/deployment-architecture.png
DIAG-005 AI 降級流程圖 ⏳ docs/diagrams/ai-fallback-flow.png

CPO 必須產出文檔

設計規格 (SPEC)

ID 文檔名稱 狀態 路徑
SPEC-UI-001 原子組件庫規格 ✅ docs/design/COMPONENT_LIBRARY.md
SPEC-UI-002 Design Tokens 定義 ⏳ docs/design/DESIGN_TOKENS.md
SPEC-UI-003 頁面線稿清單 ⏳ docs/design/WIREFRAMES.md
SPEC-UI-004 i18n 字典檔結構 ⏳ docs/design/I18N_STRUCTURE.md
SPEC-UI-005 無障礙規範 ⏳ docs/design/ACCESSIBILITY.md

流程圖 (DIAGRAM)

ID 圖表名稱 狀態 路徑
DIAG-UI-001 用戶流程圖 ⏳ docs/diagrams/user-flow.png
DIAG-UI-002 頁面導航圖 ⏳ docs/diagrams/navigation-map.png
DIAG-UI-003 組件關係圖 ⏳ docs/diagrams/component-hierarchy.png

CIO 必須產出文檔

基礎設施規格 (SPEC)

ID 文檔名稱 狀態 路徑
SPEC-INFRA-001 四主機架構說明 ⏳ docs/infrastructure/HOSTS.md
SPEC-INFRA-002 K8s Namespace 規格 ⏳ docs/infrastructure/K8S_NAMESPACES.md
SPEC-INFRA-003 Nginx 路由配置 ⏳ docs/infrastructure/NGINX_CONFIG.md
SPEC-INFRA-004 NetworkPolicy 規格 ⏳ docs/infrastructure/NETWORK_POLICY.md
SPEC-INFRA-005 資源配額設定 ⏳ docs/infrastructure/RESOURCE_QUOTAS.md

運維手冊 (RUNBOOK)

ID 文檔名稱 狀態 路徑
RUNBOOK-001 部署操作手冊 ⏳ docs/runbook/DEPLOYMENT.md
RUNBOOK-002 回滾操作手冊 ⏳ docs/runbook/ROLLBACK.md
RUNBOOK-003 災難恢復手冊 ⏳ docs/runbook/DISASTER_RECOVERY.md
RUNBOOK-004 監控告警手冊 ⏳ docs/runbook/MONITORING.md
RUNBOOK-005 日誌查詢手冊 ⏳ docs/runbook/LOGGING.md

架構圖 (DIAGRAM)

ID 圖表名稱 狀態 路徑
DIAG-INFRA-001 網路拓撲圖 ⏳ docs/diagrams/network-topology.png
DIAG-INFRA-002 K8s 部署圖 ⏳ docs/diagrams/k8s-deployment.png
DIAG-INFRA-003 監控架構圖 ⏳ docs/diagrams/monitoring-architecture.png

CISO 必須產出文檔

安全文檔 (SECURITY)

ID 文檔名稱 狀態 路徑
SEC-001 RBAC 權限架構 ✅ docs/security/RBAC_SCHEMA.md
SEC-002 機密參考指南 ✅ docs/security/SECRETS_REFERENCE.md
SEC-003 威脅模型分析 ⏳ docs/security/THREAT_MODEL.md
SEC-004 滲透測試報告 ⏳ docs/security/PENTEST_REPORT.md
SEC-005 安全稽核清單 ⏳ docs/security/AUDIT_CHECKLIST.md
SEC-006 日誌脫敏規範 ⏳ docs/security/LOG_SANITIZATION.md

流程圖 (DIAGRAM)

ID 圖表名稱 狀態 路徑
DIAG-SEC-001 認證流程圖 ⏳ docs/diagrams/auth-flow.png
DIAG-SEC-002 簽核流程圖 ⏳ docs/diagrams/approval-flow.png
DIAG-SEC-003 資料脫敏流程 ⏳ docs/diagrams/data-masking-flow.png

共用文檔

專案管理

ID 文檔名稱 狀態 路徑
PM-001 WBS 工作分解 ✅ docs/architecture/WBS.md
PM-002 LOGBOOK 進度軌跡 ✅ docs/LOGBOOK.md
PM-003 依賴清單 ✅ docs/DEPENDENCIES.md
PM-004 架構盤點清單 ✅ docs/ARCHITECTURE_INVENTORY.md

會議記錄

ID 文檔名稱 狀態 路徑
MTG-001 Phoenix Rising 戰略會議 ✅ docs/meetings/2026-03-20_PHOENIX_RISING_STRATEGY.md
MTG-002 前端重構戰略會議 ✅ docs/meetings/2026-03-19_FRONTEND_RESTRUCTURE_STRATEGY.md

配置版本控制清單

CEO 指示 #8: 所有服務、監控、工具、網路配置必須版本控制

配置類型 路徑 負責人
K8s Deployment k8s/deployments/ CIO
K8s Services k8s/services/ CIO
K8s ConfigMaps k8s/configmaps/ CIO
K8s Secrets (模板) k8s/secrets/ CIO
K8s NetworkPolicy k8s/network-policies/ CIO
K8s ResourceQuota k8s/quotas/ CIO
Nginx 配置 k8s/nginx/ CIO
Prometheus Rules k8s/monitoring/prometheus/ CIO
Alertmanager 配置 k8s/monitoring/alertmanager/ CIO
GitHub Actions .github/workflows/ CTO
Dockerfile apps/*/Dockerfile CTO
Docker Compose docker-compose.*.yml CTO

文檔完成度統計

單位 總數 完成 進行中 完成率
CTO 17 6 11 35%
CPO 8 1 7 13%
CIO 13 0 13 0%
CISO 9 2 7 22%
共用 6 6 0 100%
總計 53 15 38 28%

變更記錄

日期 版本 變更 作者
2026-03-20 v1.0 初版建立 CTO

此文件由 CTO 維護，每週 Review 更新文檔完成進度。

Reference in New Issue View Git Blame Copy Permalink