02-开发规范
版本管理、文档编写规范、文件命名等
版本管理制度
本项目采用严格的版本管理制度,版本号是核心标识:
版本格式: V{主版本}.{次版本}.{修订号}
当前版本: V5.5.23(以 `config/template-version.yaml` 为准)版本更新流程
- 编辑当前文件: 直接在
analysis-template.md或对应template/*.md上修改,不要新建平行版本 - 更新版本号: 同步更新以下位置的版本号:
- 文档顶部标题
- README.md
- docs/CHANGELOG.md
- 所有脚本中的版本注释
- 记录变更: 在 docs/CHANGELOG.md 添加变更记录
- 归档旧版本: 将旧版本复制到
archive/templates/目录
文件命名规范
| 类型 | 命名格式 | 示例 |
|---|---|---|
| 当前版本 | analysis-template.md | (固定,始终是最新版) |
| 历史版本 | 个股分析标准模版_V{版本号}_{版本名}.md | 个股分析标准模版_V5.5.6_实战机制深化版.md |
| 分析报告 | {公司名称}_{股票代码}_投资分析报告.md | 保利物业_06049_投资分析报告.md |
禁止: 创建"快速参考"、"速览"等辅助文件;禁止为同一公司保留多份历史版本报告
文档编写规范
标签系统
| 标签 | 含义 | AI角色 | 人工角色 |
|---|---|---|---|
[COMPUTABLE] | 可计算指标 | 抓取数据、计算比率、生成表格 | 验证数据源、检查异常值 |
[LLM-REQUIRED] | 需AI分析 | 文本分析、模式识别、趋势判断 | 复核逻辑、确认结论 |
[MANUAL-ONLY] | 必须人工 | 提供计算框架 | 最终判断、决策执行 |
[CROSS-CHECK] | 交叉验证 | 提供多源数据对比 | 确认差异原因 |
[TREND-ANALYSIS] | 趋势分析 | 计算5年趋势、标记异常 | 判断趋势质量 |
[DATA-CONFIDENCE] | 数据置信度 | 标记数据可信度等级 | 核实关键数据 |
数据源分级
| 等级 | 数据源 | 使用限制 |
|---|---|---|
| S级 | 公司年报、港交所披露易 | 可全额建仓 |
| A级 | 公司官网、投资者关系 | 需与S级交叉验证 |
| B级 | Bloomberg、Wind、东方财富 | 不得用于核心财务数据 |
| C级 | 财经媒体、研报、社区 | 仅供参考 |
| D级 | AI估算、行业惯例推测 | 禁止用于投资决策 |
分析报告生成规范
输出要求
- 输出目录:
analysis-reports/ - 文件命名:
{公司名称}_{股票代码}_投资分析报告.md - 首行强制要求: 必须先给出
一句话结论- 格式:
**一句话结论**:<当前状态+估值位置+操作建议>
- 格式:
重复报告处理
- 原则: 一个公司报告只要一份最新版本
- 操作: 发现同名报告时,直接覆盖旧版本,不保留历史版本
更新网页配置(必须)
生成报告后必须更新以下配置:
侧边栏配置:
.vitepress/config.mjsjavascript{ text: '新公司名称_代码_投资分析报告', link: '/analysis-reports/文件名' }目录索引:
analysis-reports/index.md首页:
index.md- 更新"最新分析报告"列表
⚠️ AI不自动执行git操作: 更新配置后告知用户完成,由用户自行决定提交
代码编写规范
Python脚本
版本注释: 每个脚本头部必须标注对应模板版本
python""" 港股金龟筛选器 V1.2 (V5.5.7熊市+消除变量版) 基于投资模板V5.5.7标准自动筛选港股标的 """编码声明: 必须包含 UTF-8 编码声明
python# -*- coding: utf-8 -*-配置集中: 筛选标准等配置使用字典常量,如
SCREENING_CONFIG
YAML配置
- 使用中文注释说明配置项
- 版本号必须与主模板一致
- 结构:仓位限制 → 止损规则 → 流动性限制 → 汇率风险 → 市场整体风控
常用命令速查
bash
# 查看最新版本号
grep -n "V5\." README.md | head -5
# 检查当前工作文件版本
rg -n "V5\." analysis-template.md | Select-Object -First 3
# 运行股票筛选
cd 01-筛选框架 && python hk_stock_screener.py
# 查看CHANGELOG
Get-Content docs/CHANGELOG.md | Select-Object -First 100版本对照表(最近5个版本)
| 版本 | 日期 | 核心特性 | 状态 |
|---|---|---|---|
| V5.5.23 | 2026-07-11 | 规则统一版:版本源、估值、数据时点、FCF双口径、报告契约、风险与仓位规则 | ✅ 当前 |
| V5.5.13 | 2026-03-30 | VHSI市场情绪监测整合版 | 已归档 |
| V5.5.12 | 2026-03-26 | 观察仓框架+成长性陷阱整合版 | 已归档 |
| V5.5.10 | 2026-03-22 | 数据质量硬约束整合版 | 已归档 |
| V5.5.9 | 2026-03-19 | 实战笔记整合版 | 已归档 |