docs: add bilingual docs structure

This commit is contained in:
Haitao Pan 2026-03-15 23:45:17 +08:00
parent 3577f560ac
commit d4bcdc933f
16 changed files with 379 additions and 0 deletions

14
docs/DOC_COVERAGE.md Normal file
View File

@ -0,0 +1,14 @@
# Documentation Coverage Matrix
This matrix tracks the bilingual canonical documentation set for `observability.svc.plus` and maps it back to the current codebase and older docs.
该矩阵用于跟踪 `observability.svc.plus` 的双语规范文档,并将其与当前代码状态和历史文档对应起来。
| Category | EN | ZH | Current status | Existing references | Next check |
| --- | --- | --- | --- | --- | --- |
| Architecture | Yes | Yes | Seeded from current codebase; deeper legacy consolidation is still needed. | None yet; use the new canonical page as the starting point. | Keep diagrams and ownership notes synchronized with actual directories, services, and integration dependencies. |
| Design | Yes | Yes | Seeded from current codebase; deeper legacy consolidation is still needed. | None yet; use the new canonical page as the starting point. | Promote one-off implementation notes into reusable design records when behavior, APIs, or deployment contracts change. |
| Deployment | Yes | Yes | Seeded from current codebase; deeper legacy consolidation is still needed. | None yet; use the new canonical page as the starting point. | Verify deployment steps against current scripts, manifests, CI/CD flow, and environment contracts before each release. |
| User Guide | Yes | Yes | Seeded from current codebase; deeper legacy consolidation is still needed. | None yet; use the new canonical page as the starting point. | 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; deeper legacy consolidation is still needed. | None yet; use the new canonical page as the starting point. | 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; deeper legacy consolidation is still needed. | None yet; use the new canonical page as the starting point. | Review prompt templates and repo rules whenever the project adds new subsystems, protected areas, or mandatory verification steps. |

31
docs/README.md Normal file
View File

@ -0,0 +1,31 @@
# Observability Service Plus / 可观测性服务
This `docs/` directory now has a bilingual canonical layer for the current repository state.
`docs/` 目录现已补齐双语规范层,用于承接当前仓库状态下的核心文档。
## Quick Entry / 快速入口
- Coverage checklist / 覆盖检查矩阵: `docs/DOC_COVERAGE.md`
- English index / 英文入口: `docs/en/README.md`
- 中文入口 / Chinese index: `docs/zh/README.md`
## Canonical Bilingual Pages / 双语规范页
- `docs/en/architecture.md` / `docs/zh/architecture.md`
- `docs/en/design.md` / `docs/zh/design.md`
- `docs/en/deployment.md` / `docs/zh/deployment.md`
- `docs/en/user-guide.md` / `docs/zh/user-guide.md`
- `docs/en/developer-guide.md` / `docs/zh/developer-guide.md`
- `docs/en/vibe-coding-reference.md` / `docs/zh/vibe-coding-reference.md`
## Current Repo Context / 当前仓库背景
- Root README: `Observability.svc.plus`
- Previous docs index: `Documentation`
- Manifest evidence / 构建清单: repository structure and scripts only
- Active code and ops directories / 当前主要目录: `app/`, `api/`, `scripts/`
## Existing Docs To Reconcile / 需要继续归并的现有文档
- No pre-existing markdown docs were detected in this repository.

23
docs/en/README.md Normal file
View File

@ -0,0 +1,23 @@
# Observability Service Plus Documentation
This repository documents infrastructure orchestration and observability composition rather than a single application binary.
## Current state snapshot
- Root README title: `Observability.svc.plus`
- Build/runtime evidence: repository structure and scripts only
- Primary directories detected: `app/`, `api/`, `scripts/`
- Existing docs count: 0
## Canonical pages
- [Architecture](architecture.md)
- [Design](design.md)
- [Deployment](deployment.md)
- [User Guide](user-guide.md)
- [Developer Guide](developer-guide.md)
- [Vibe Coding Reference](vibe-coding-reference.md)
## Legacy docs to fold in
- No pre-existing markdown docs were detected in this repository.

24
docs/en/architecture.md Normal file
View File

@ -0,0 +1,24 @@
# Architecture
This repository documents infrastructure orchestration and observability composition rather than a single application binary.
Use this page as the canonical bilingual overview of system boundaries, major components, and repo ownership.
## Current code-aligned notes
- Documentation target: `observability.svc.plus`
- Repo kind: `infra-observability`
- Manifest and build evidence: repository structure and scripts only
- Primary implementation and ops directories: `app/`, `api/`, `scripts/`
- Package scripts snapshot: No package.json scripts were detected.
## Existing docs to reconcile
- No directly matching legacy docs were detected; this page is currently the canonical seed.
## What this page should cover next
- Describe the current implementation rather than an aspirational future-only design.
- Keep terminology aligned with the repository root README, manifests, and actual directories.
- Link deeper runbooks, specs, or subsystem notes from the legacy docs listed above.
- Keep diagrams and ownership notes synchronized with actual directories, services, and integration dependencies.

24
docs/en/deployment.md Normal file
View File

@ -0,0 +1,24 @@
# Deployment
This repository documents infrastructure orchestration and observability composition rather than a single application binary.
Use this page to standardize deployment prerequisites, supported topologies, operational checks, and rollback notes.
## Current code-aligned notes
- Documentation target: `observability.svc.plus`
- Repo kind: `infra-observability`
- Manifest and build evidence: repository structure and scripts only
- Primary implementation and ops directories: `app/`, `api/`, `scripts/`
- Package scripts snapshot: No package.json scripts were detected.
## Existing docs to reconcile
- No directly matching legacy docs were detected; this page is currently the canonical seed.
## What this page should cover next
- Describe the current implementation rather than an aspirational future-only design.
- Keep terminology aligned with the repository root README, manifests, and actual directories.
- Link deeper runbooks, specs, or subsystem notes from the legacy docs listed above.
- Verify deployment steps against current scripts, manifests, CI/CD flow, and environment contracts before each release.

24
docs/en/design.md Normal file
View File

@ -0,0 +1,24 @@
# Design
This repository documents infrastructure orchestration and observability composition rather than a single application binary.
Use this page to consolidate design decisions, ADR-style tradeoffs, and roadmap-sensitive implementation notes.
## Current code-aligned notes
- Documentation target: `observability.svc.plus`
- Repo kind: `infra-observability`
- Manifest and build evidence: repository structure and scripts only
- Primary implementation and ops directories: `app/`, `api/`, `scripts/`
- Package scripts snapshot: No package.json scripts were detected.
## Existing docs to reconcile
- No directly matching legacy docs were detected; this page is currently the canonical seed.
## What this page should cover next
- Describe the current implementation rather than an aspirational future-only design.
- Keep terminology aligned with the repository root README, manifests, and actual directories.
- Link deeper runbooks, specs, or subsystem notes from the legacy docs listed above.
- Promote one-off implementation notes into reusable design records when behavior, APIs, or deployment contracts change.

View File

@ -0,0 +1,24 @@
# Developer Guide
This repository documents infrastructure orchestration and observability composition rather than a single application binary.
Use this page to document local setup, project structure, test surfaces, and contribution conventions tied to the current codebase.
## Current code-aligned notes
- Documentation target: `observability.svc.plus`
- Repo kind: `infra-observability`
- Manifest and build evidence: repository structure and scripts only
- Primary implementation and ops directories: `app/`, `api/`, `scripts/`
- Package scripts snapshot: No package.json scripts were detected.
## Existing docs to reconcile
- No directly matching legacy docs were detected; this page is currently the canonical seed.
## What this page should cover next
- Describe the current implementation rather than an aspirational future-only design.
- Keep terminology aligned with the repository root README, manifests, and actual directories.
- Link deeper runbooks, specs, or subsystem notes from the legacy docs listed above.
- Keep setup and test commands tied to actual package scripts, Make targets, or language toolchains in this repository.

24
docs/en/user-guide.md Normal file
View File

@ -0,0 +1,24 @@
# User Guide
This repository documents infrastructure orchestration and observability composition rather than a single application binary.
Use this page to document primary user/operator tasks, everyday workflows, and navigation to existing how-to material.
## Current code-aligned notes
- Documentation target: `observability.svc.plus`
- Repo kind: `infra-observability`
- Manifest and build evidence: repository structure and scripts only
- Primary implementation and ops directories: `app/`, `api/`, `scripts/`
- Package scripts snapshot: No package.json scripts were detected.
## Existing docs to reconcile
- No directly matching legacy docs were detected; this page is currently the canonical seed.
## What this page should cover next
- Describe the current implementation rather than an aspirational future-only design.
- Keep terminology aligned with the repository root README, manifests, and actual directories.
- Link deeper runbooks, specs, or subsystem notes from the legacy docs listed above.
- Prefer workflow-oriented examples and keep screenshots or terminal snippets aligned with the latest UI or CLI behavior.

View File

@ -0,0 +1,24 @@
# Vibe Coding Reference
This repository documents infrastructure orchestration and observability composition rather than a single application binary.
Use this page to align AI-assisted coding prompts, repo boundaries, safe edit rules, and documentation update expectations.
## Current code-aligned notes
- Documentation target: `observability.svc.plus`
- Repo kind: `infra-observability`
- Manifest and build evidence: repository structure and scripts only
- Primary implementation and ops directories: `app/`, `api/`, `scripts/`
- Package scripts snapshot: No package.json scripts were detected.
## Existing docs to reconcile
- No directly matching legacy docs were detected; this page is currently the canonical seed.
## What this page should cover next
- Describe the current implementation rather than an aspirational future-only design.
- Keep terminology aligned with the repository root README, manifests, and actual directories.
- Link deeper runbooks, specs, or subsystem notes from the legacy docs listed above.
- Review prompt templates and repo rules whenever the project adds new subsystems, protected areas, or mandatory verification steps.

23
docs/zh/README.md Normal file
View File

@ -0,0 +1,23 @@
# 可观测性服务 文档
该仓库更偏向基础设施编排与可观测体系组合,而不是单一应用二进制。
## 当前状态快照
- 根 README 标题: `Observability.svc.plus`
- 构建与运行时证据: repository structure and scripts only
- 自动识别的主要目录: `app/`, `api/`, `scripts/`
- 现有文档数量: 0
## 核心双语文档
- [架构](architecture.md)
- [设计](design.md)
- [部署](deployment.md)
- [使用手册](user-guide.md)
- [开发手册](developer-guide.md)
- [Vibe Coding 参考](vibe-coding-reference.md)
## 待归并的历史文档
- No pre-existing markdown docs were detected in this repository.

24
docs/zh/architecture.md Normal file
View File

@ -0,0 +1,24 @@
# 架构
该仓库更偏向基础设施编排与可观测体系组合,而不是单一应用二进制。
本页作为系统边界、核心组件与仓库职责的双语总览入口。
## 与当前代码对齐的说明
- 文档目标仓库: `observability.svc.plus`
- 仓库类型: `infra-observability`
- 构建与运行依据: repository structure and scripts only
- 主要实现与运维目录: `app/`, `api/`, `scripts/`
- `package.json` 脚本快照: No package.json scripts were detected.
## 需要继续归并的现有文档
- 尚未发现直接对应的历史文档,本页目前就是该类别的规范起点。
## 本页下一步应补充的内容
- 先描述当前已落地实现,再补充未来规划,避免只写愿景不写现状。
- 术语需要与仓库根 README、构建清单和实际目录保持一致。
- 将上方列出的历史 runbook、spec、子系统说明逐步链接并归并到本页。
- 随着目录结构、服务关系和集成依赖变化,持续同步图示与职责说明。

24
docs/zh/deployment.md Normal file
View File

@ -0,0 +1,24 @@
# 部署
该仓库更偏向基础设施编排与可观测体系组合,而不是单一应用二进制。
本页用于统一部署前提、支持的拓扑、运维检查项与回滚注意事项。
## 与当前代码对齐的说明
- 文档目标仓库: `observability.svc.plus`
- 仓库类型: `infra-observability`
- 构建与运行依据: repository structure and scripts only
- 主要实现与运维目录: `app/`, `api/`, `scripts/`
- `package.json` 脚本快照: No package.json scripts were detected.
## 需要继续归并的现有文档
- 尚未发现直接对应的历史文档,本页目前就是该类别的规范起点。
## 本页下一步应补充的内容
- 先描述当前已落地实现,再补充未来规划,避免只写愿景不写现状。
- 术语需要与仓库根 README、构建清单和实际目录保持一致。
- 将上方列出的历史 runbook、spec、子系统说明逐步链接并归并到本页。
- 每次发布前依据当前脚本、清单、CI/CD 流程和环境契约重新核对部署步骤。

24
docs/zh/design.md Normal file
View File

@ -0,0 +1,24 @@
# 设计
该仓库更偏向基础设施编排与可观测体系组合,而不是单一应用二进制。
本页用于汇总设计决策、类似 ADR 的权衡记录,以及与路线图相关的实现说明。
## 与当前代码对齐的说明
- 文档目标仓库: `observability.svc.plus`
- 仓库类型: `infra-observability`
- 构建与运行依据: repository structure and scripts only
- 主要实现与运维目录: `app/`, `api/`, `scripts/`
- `package.json` 脚本快照: No package.json scripts were detected.
## 需要继续归并的现有文档
- 尚未发现直接对应的历史文档,本页目前就是该类别的规范起点。
## 本页下一步应补充的内容
- 先描述当前已落地实现,再补充未来规划,避免只写愿景不写现状。
- 术语需要与仓库根 README、构建清单和实际目录保持一致。
- 将上方列出的历史 runbook、spec、子系统说明逐步链接并归并到本页。
- 当行为、API 或部署契约发生变化时,把一次性实现笔记提升为可复用设计记录。

View File

@ -0,0 +1,24 @@
# 开发手册
该仓库更偏向基础设施编排与可观测体系组合,而不是单一应用二进制。
本页用于记录本地开发环境、项目结构、测试面与贴合当前代码库的贡献约定。
## 与当前代码对齐的说明
- 文档目标仓库: `observability.svc.plus`
- 仓库类型: `infra-observability`
- 构建与运行依据: repository structure and scripts only
- 主要实现与运维目录: `app/`, `api/`, `scripts/`
- `package.json` 脚本快照: No package.json scripts were detected.
## 需要继续归并的现有文档
- 尚未发现直接对应的历史文档,本页目前就是该类别的规范起点。
## 本页下一步应补充的内容
- 先描述当前已落地实现,再补充未来规划,避免只写愿景不写现状。
- 术语需要与仓库根 README、构建清单和实际目录保持一致。
- 将上方列出的历史 runbook、spec、子系统说明逐步链接并归并到本页。
- 持续让环境搭建与测试命令对应真实存在的脚本、Make 目标或语言工具链。

24
docs/zh/user-guide.md Normal file
View File

@ -0,0 +1,24 @@
# 使用手册
该仓库更偏向基础设施编排与可观测体系组合,而不是单一应用二进制。
本页用于记录主要用户或运维角色的日常任务、常见流程,以及现有操作文档入口。
## 与当前代码对齐的说明
- 文档目标仓库: `observability.svc.plus`
- 仓库类型: `infra-observability`
- 构建与运行依据: repository structure and scripts only
- 主要实现与运维目录: `app/`, `api/`, `scripts/`
- `package.json` 脚本快照: No package.json scripts were detected.
## 需要继续归并的现有文档
- 尚未发现直接对应的历史文档,本页目前就是该类别的规范起点。
## 本页下一步应补充的内容
- 先描述当前已落地实现,再补充未来规划,避免只写愿景不写现状。
- 术语需要与仓库根 README、构建清单和实际目录保持一致。
- 将上方列出的历史 runbook、spec、子系统说明逐步链接并归并到本页。
- 优先提供面向流程的示例,并确保截图或终端片段与最新 UI/CLI 行为一致。

View File

@ -0,0 +1,24 @@
# Vibe Coding 参考
该仓库更偏向基础设施编排与可观测体系组合,而不是单一应用二进制。
本页用于统一 AI 辅助开发提示词、仓库边界、安全编辑规则与文档同步要求。
## 与当前代码对齐的说明
- 文档目标仓库: `observability.svc.plus`
- 仓库类型: `infra-observability`
- 构建与运行依据: repository structure and scripts only
- 主要实现与运维目录: `app/`, `api/`, `scripts/`
- `package.json` 脚本快照: No package.json scripts were detected.
## 需要继续归并的现有文档
- 尚未发现直接对应的历史文档,本页目前就是该类别的规范起点。
## 本页下一步应补充的内容
- 先描述当前已落地实现,再补充未来规划,避免只写愿景不写现状。
- 术语需要与仓库根 README、构建清单和实际目录保持一致。
- 将上方列出的历史 runbook、spec、子系统说明逐步链接并归并到本页。
- 当项目新增子系统、受保护目录或强制验证步骤时,同步更新提示模板与仓库规则。