Fundamental_Analysis/docs

项目文档中心

欢迎来到基本面选股系统的文档中心。本文档旨在作为项目所有相关文档的入口和导航，帮助团队成员快速找到所需信息。

概览

本文档库遵循特定的结构化命名和分类约定，旨在清晰地分离不同领域的关注点。主要目录结构如下：

• /1_requirements: 存放所有与产品需求和用户功能相关的文档。
• /2_architecture: 包含系统高级架构、设计原则和核心规范。
• /3_project_management: 用于项目跟踪、开发日志和任务管理。
• /4_archive: 存放已合并或过时的历史文档。
• /5_data_dictionary: 定义系统中使用的数据模型和字段。

---

快速导航

以下是项目中几个最核心文档的快速访问链接，直接指向其关键章节。

1. 需求与功能

• [需求文档 (requirements.md)] - 定义了产品的核心功能和MVP版本的验收标准。

  • 查看系统核心功能
  • 了解九大分析模块
  • 查看报告生成进度追踪需求

• [用户使用文档 (user-guide.md)] - 为系统的最终用户提供详细的操作指南。

  • 快速入门指引
  • 财务数据指标解读
  • 首次使用的系统配置

2. 架构与设计

• [系统架构总览 (system_architecture.md)] - 项目的“单一事实源”，描述了事件驱动微服务架构的核心理念。

  • 核心架构理念与原则
  • 目标架构图
  • 数据库 Schema 设计概览

• [系统模块设计准则 (architecture_module_specification.md)] - 对微服务必须遵守的 SystemModule 行为契约进行了形式化定义。

  • 核心思想：SystemModule Trait
  • 强制实现的可观测性接口 (/health, /tasks)

3. 数据与模型

• [财务数据字典 (financial_data_dictionary.md)] - 定义了所有前端展示的财务指标及其在不同数据源（Tushare, Finnhub）的映射关系。

  • 查看主要财务指标定义
  • 查看资产负债结构定义

• [数据库 Schema 详细设计 (database_schema_design.md)] - 提供了所有核心数据表的详细 CREATE TABLE 语句和设计哲学。

  • 为何选择 TimescaleDB
  • 查看 time_series_financials 表结构
  • 查看 analysis_results 表结构

4. 项目管理

• [项目当前状态 (project-status.md)] - 一个动态更新的文档，记录了项目的当前进展、已知问题和下一步计划。

  • 查看当前功能与数据状态
  • 查看已知问题与限制
  • 查看后续开发计划

• 开发日志与任务:

  • 查看所有开发日志
  • 查看已完成的任务