2.8 KiB
2.8 KiB
Documentation Coverage Matrix
This matrix tracks the bilingual canonical documentation set for console.svc.plus and maps it back to the current codebase and older docs.
该矩阵用于跟踪 console.svc.plus 的双语规范文档,并将其与当前代码状态和历史文档对应起来。
| Category | EN | ZH | Current status | Existing references | Next check |
|---|---|---|---|---|---|
| Architecture | Yes | Yes | Seeded from current codebase and existing docs. | api/overview.mdarchitecture/components.mdarchitecture/design-decisions.mdarchitecture/overview.mdarchitecture/roadmap.mddevelopment/code-structure.mdzh/api/overview.mdzh/architecture/components.md |
Keep diagrams and ownership notes synchronized with actual directories, services, and integration dependencies. |
| Design | Yes | Yes | Seeded from current codebase and existing docs. | SEO-WORK-SUMMARY.mdarchitecture/design-decisions.mdzh/SEO-WORK-SUMMARY.mdzh/architecture/design-decisions.md |
Promote one-off implementation notes into reusable design records when behavior, APIs, or deployment contracts change. |
| Deployment | Yes | Yes | Seeded from current codebase and existing docs. | development/dev-setup.mdgetting-started/installation.mdgetting-started/quickstart.mdgovernance/release-process.mdoperations/runbooks/README.mdoperations/runbooks/rag-server.mdusage/deployment.mdzh/development/dev-setup.md |
Verify deployment steps against current scripts, manifests, CI/CD flow, and environment contracts before each release. |
| User Guide | Yes | Yes | Seeded from current codebase and existing docs. | api/overview.mdarchitecture/overview.mdgetting-started/concepts.mdgetting-started/installation.mdgetting-started/introduction.mdgetting-started/quickstart.mdusage/cli.mdusage/config.md |
Prefer workflow-oriented examples and keep screenshots or terminal snippets aligned with the latest UI or CLI behavior. |
| Developer Guide | Yes | Yes | Seeded from current codebase and existing docs. | api/auth.mdapi/endpoints.mdapi/errors.mdapi/overview.mddevelopment/code-structure.mddevelopment/contributing.mddevelopment/dev-setup.mddevelopment/testing.md |
Keep setup and test commands tied to actual package scripts, Make targets, or language toolchains in this repository. |
| Vibe Coding Reference | Yes | Yes | Seeded from current codebase and existing docs. | api/auth.mdapi/endpoints.mdapi/errors.mdapi/overview.mdzh/api/auth.mdzh/api/endpoints.mdzh/api/errors.mdzh/api/overview.md |
Review prompt templates and repo rules whenever the project adds new subsystems, protected areas, or mandatory verification steps. |