83 lines
2.7 KiB
Markdown
83 lines
2.7 KiB
Markdown
# FischerX 文档中心
|
|
|
|
> **文档版本**: v1.0.0
|
|
> **最后更新**: 2026-05-25
|
|
|
|
欢迎来到 FischerX 文档中心！这里包含了项目的所有文档。
|
|
|
|
## 快速导航
|
|
|
|
### 架构文档 (architecture/)
|
|
- [系统架构](./architecture/system-architecture.md](./architecture/system-architecture.md) - 系统整体架构设计
|
|
- [技术选型](./architecture/tech-stack.md) - 技术选型说明
|
|
- [架构决策记录 (ADR)](./architecture/adr/) - 重要技术决策历史
|
|
|
|
### 需求文档 (requirements/)
|
|
- [产品需求文档 (PRD)](./requirements/prd.md) - 产品需求说明
|
|
- [用户故事](./requirements/product/user-stories.md) - 用户故事列表
|
|
- [功能规格](./requirements/features/) - 详细功能规格
|
|
|
|
### 设计文档 (design/)
|
|
- [数据库设计](./design/database/schema.md) - 数据库 Schema 设计
|
|
- [API 设计](./design/api/) - API 接口设计
|
|
- [UI 设计](./design/ui/) - UI 设计文档
|
|
|
|
### 开发文档 (development/)
|
|
- [快速开始](./development/quick-start.md) - 新手指南
|
|
- [开发规范](./development/standards/) - 代码规范
|
|
- [最佳实践](./development/best-practices/) - 开发最佳实践
|
|
|
|
### API 文档 (api/)
|
|
- [API 参考](./api/) - 接口文档
|
|
- [SDK 文档](./api/sdk/) - SDK 使用说明
|
|
- [错误码](./api/error-codes.md) - 错误码说明
|
|
|
|
### 测试文档 (testing/)
|
|
- [测试计划](./testing/test-plan.md) - 测试计划
|
|
- [测试用例](./testing/test-cases/) - 测试用例
|
|
- [测试报告](./testing/test-reports/) - 测试报告
|
|
|
|
### 部署文档 (deployment/)
|
|
- [环境配置](./deployment/environments.md) - 环境配置说明
|
|
- [部署指南](./deployment/deployment-guide.md) - 部署操作指南
|
|
- [CI/CD](./deployment/ci-cd.md) - 持续集成/部署
|
|
|
|
### 运维文档 (operations/)
|
|
- [监控告警](./operations/monitoring.md) - 监控配置
|
|
- [日志管理](./operations/logging.md) - 日志管理
|
|
- [故障处理](./operations/troubleshooting/) - 故障排查指南
|
|
- [备份恢复](./operations/backup-restore.md) - 数据备份
|
|
|
|
### 用户文档 (user/)
|
|
- [用户手册](./user/user-manual.md) - 用户使用手册
|
|
- [快速入门](./user/getting-started.md) - 用户入门指南
|
|
- [FAQ](./user/faq.md) - 常见问题
|
|
|
|
### 文档模板 (templates/)
|
|
- [ADR 模板](./templates/adr-template.md) - 架构决策记录模板
|
|
- [API 文档模板](./templates/api-doc-template.md) - API 文档模板
|
|
|
|
---
|
|
|
|
## 文档规范
|
|
|
|
所有文档遵循 [FischerX 文档管理规范](../FischerX%E6%96%87%E6%A1%A3%E7%AE%A1%E8%8C%83.md)。
|
|
|
|
## 贡献文档
|
|
|
|
如果你发现文档有问题或需要补充，请：
|
|
|
|
1. Fork 本仓库
|
|
2. 修改文档
|
|
3. 提交 Pull Request
|
|
4. 等待审核合并
|
|
|
|
## 获取帮助：
|
|
- 提交 Issue
|
|
- 联系文档负责人
|
|
- 飞书群反馈
|
|
|
|
---
|
|
|
|
> **最后更新**: 2026-05-25
|