93 lines
3.8 KiB
Markdown
93 lines
3.8 KiB
Markdown
# ISOS 项目文档
|
||
|
||
本目录包含 ISOS Agent Teams 软件研发模板的全部项目文档。
|
||
|
||
---
|
||
|
||
## 文档索引
|
||
|
||
### 核心文档
|
||
|
||
| 文档 | 用途 |
|
||
|------|------|
|
||
| [`01-用户需求.md`](./01-用户需求.md) | 用户视角需求、项目目标、验收标准 |
|
||
| [`02-产品需求.md`](./02-产品需求.md) | 非功能性需求、约束、风险、边缘情况 |
|
||
| [`03-功能列表.md`](./03-功能列表.md) | 按优先级组织的功能需求（FR）列表 |
|
||
| [`04-用户故事.md`](./04-用户故事.md) | 用户故事（US）集合 |
|
||
| [`07-系统架构.md`](./07-系统架构.md) | 系统架构图、技术架构、模块划分 |
|
||
| [`08-数据库设计.md`](./08-数据库设计.md) | 关键实体数据模型 |
|
||
| [`11-工程规范.md`](./11-工程规范.md) | 术语表、工程规范 |
|
||
| [`09-API契约.md`](./09-API契约.md) | API 契约、接口定义 |
|
||
| [`13-Mermaid图集.md`](./13-Mermaid图集.md) | 全项目 Mermaid 图汇总索引 |
|
||
|
||
### 设计文档
|
||
|
||
| 文档 | 用途 |
|
||
|------|------|
|
||
| [`设计-Apple风格.md`](./设计-Apple风格.md) | Apple 风格设计系统（色彩、排版、组件规范） |
|
||
| [`05-设计-UI.md`](./05-设计-UI.md) | UI 界面设计规范 |
|
||
| [`06-设计-UX.md`](./06-设计-UX.md) | UX 用户体验设计、交互模式 |
|
||
|
||
### 管理文档
|
||
|
||
| 文档 | 用途 |
|
||
|------|------|
|
||
| [`12-管理-项目.md`](./12-管理-项目.md) | 项目管理、工作流程、协作规范 |
|
||
| [`管理-开发入门.md`](./管理-开发入门.md) | Claude Code 工具链配置与开发入门指引 |
|
||
| [`管理-开发环境搭建.md`](./管理-开发环境搭建.md) | 本地开发环境配置、依赖安装 |
|
||
| [`管理-Agent-Team分工及提示词.md`](./管理-Agent-Team分工及提示词.md) | Agent Team 分工及提示词 |
|
||
|
||
### 运维文档
|
||
|
||
| 文档 | 用途 |
|
||
|------|------|
|
||
| [`运维-部署实施.md`](./运维-部署实施.md) | 部署实施方案 |
|
||
| [`运维-发布日志.md`](./运维-发布日志.md) | 版本变更历史、功能更新记录 |
|
||
| [`运维-安全审计.md`](./运维-安全审计.md) | 安全策略、漏洞跟踪 |
|
||
| [`运维-故障排除.md`](./运维-故障排除.md) | 常见问题排查、错误码对照、诊断指引 |
|
||
| [`运维-性能基准.md`](./运维-性能基准.md) | 性能基准 |
|
||
|
||
### 测试文档
|
||
|
||
| 文档 | 用途 |
|
||
|------|------|
|
||
| [`10-测试-方案.md`](./10-测试-方案.md) | 测试策略（含单元/功能/集成/系统/接口/端到端/验收各级别） |
|
||
| [`测试-计划.md`](./测试-计划.md) | 测试计划 |
|
||
| [`测试-用例.md`](./测试-用例.md) | 测试用例（按级别组织） |
|
||
| [`测试-单元.md`](./测试-单元.md) | 单元测试标准与规范（开发者维护） |
|
||
| [`测试-接口.md`](./测试-接口.md) | 接口测试规范 |
|
||
| [`测试-接口-分类.md`](./测试-接口-分类.md) | 分类接口测试用例模板 |
|
||
| [`测试-报告.md`](./测试-报告.md) | 测试执行报告与缺陷跟踪 |
|
||
|
||
---
|
||
|
||
## 阅读指引
|
||
|
||
**快速了解项目**: 01-用户需求.md -> 07-系统架构.md -> 03-功能列表.md
|
||
|
||
**开发准备**: 02-产品需求.md -> 09-API契约.md -> 08-数据库设计.md -> 11-工程规范.md -> 管理-开发环境搭建.md
|
||
|
||
**UI 开发**: 设计-Apple风格.md -> 05-设计-UI.md -> 06-设计-UX.md -> team/svelte.md
|
||
|
||
**测试编写**: 10-测试-方案.md -> 测试-用例.md -> 01-用户需求.md（验收标准）
|
||
|
||
**问题排查**: 运维-故障排除.md -> 运维-发布日志.md
|
||
|
||
---
|
||
|
||
## 文档命名规范
|
||
|
||
本目录下所有 `.md` 文件统一使用**中文文件名**，仅 UI/UX 等国际通用缩写可在文件名中保留英文缩写。
|
||
|
||
**命名规则**：
|
||
- **核心文档**: `01-` ~ `12-` 编号前缀
|
||
- **设计文档**: `设计-` 前缀
|
||
- **管理文档**: `管理-` 前缀
|
||
- **运维文档**: `运维-` 前缀
|
||
- **测试文档**: `测试-` 前缀
|
||
|
||
---
|
||
|
||
**版本历史**:
|
||
- v1.0.0 (2026-04-19): 初始化 ISOS Agent Teams 软件研发模板
|