生效文档（Active Documentation）¶

概述¶

此文件夹包含所有当前项目使用的权威文档。这些文档与代码实现保持同步，是开发的唯一真实来源。

文件夹结构¶

Text Only

01-active/
├── LOGIN/                              # 登录功能文档
│   ├── login_design_final.md           # 权威文档：登录功能完整设计
│   ├── login_quick_reference.md        # 快速参考：登录功能速查表
│   └── README.md                       # 本文件夹说明
├── AUTHENTICATION/                     # 认证功能文档
│   ├── superadmin_login.md             # 超级管理员登录
│   └── README.md
└── README.md                           # 本文件说明

文档清单¶

1. login_design_final.md¶

版本: 2.0
最后更新: 2026-03-15
状态: ✅ 生效中
说明: 登录功能的完整设计文档，包含所有功能规则、实现细节和测试清单
关键内容:
验证码显示规则
失败次数计数（基于 Phone + IP）
账户锁定机制
登录流程详解
测试清单

2. login_quick_reference.md¶

版本: 1.0
最后更新: 2026-03-15
状态: ✅ 生效中
说明: 登录功能的快速参考卡片，便于快速查阅
关键内容:
核心设计速查
代码位置
关键方法
常见问题

AUTHENTICATION（认证功能）¶

1. superadmin_login.md¶

版本: 1.0
最后更新: 2026-02-02
状态: ✅ 生效中
说明: 超级管理员登录的特殊处理
关键内容:
超级管理员登录流程
权限检查
特殊处理规则

使用指南¶

查找文档¶

快速查找 - 使用 login_quick_reference.md
详细了解 - 查看 login_design_final.md
特殊功能 - 查看对应的专门文档

更新文档¶

每次功能变更时：

更新对应的生效文档
更新版本号和修改日期
在版本历史中记录变更
检查是否需要归档旧文档
更新 CLAUDE.md 中的引用

归档文档¶

当文档过期时：

在 docs/02-archived/{CATEGORY}/ARCHIVE_LOG.md 中添加记录
将文档移入 docs/02-archived/{CATEGORY}/
更新本文件夹的文档清单
更新 CLAUDE.md 中的引用

文档版本管理¶

每个文档顶部应包含版本信息：

Markdown

**版本**: X.Y
**最后更新**: YYYY-MM-DD
**更新者**: 名字
**状态**: ✅ 生效中

## 版本历史

### vX.Y (YYYY-MM-DD)
- 变更说明

### vX.Y-1 (YYYY-MM-DD)
- 变更说明

文档审查¶

定期审查（每月）¶

检查文档是否与代码一致
检查版本号是否正确
检查是否有需要归档的文档
检查是否有遗漏的文档

代码审查时¶

检查是否需要更新文档
检查文档与代码是否一致
检查是否需要添加新文档

与代码的关系¶

代码注释¶

在关键代码处添加文档引用：

C#

// 根据 docs/01-active/LOGIN/login_design_final.md 第 132 行
// 验证码显示时机：登录失败 1 次后
if (failedCount >= 1)
{
    ViewBag.ShowCaptcha = true;
}

Git 提交¶

提交登录相关变更时，在提交信息中引用文档：

Text Only

feat: 修改验证码显示时机

根据 docs/01-active/LOGIN/login_design_final.md v2.0 更新：
- 验证码显示时机改为失败 1 次后
- 失败次数计数改为 Phone + IP

相关文档：docs/01-active/LOGIN/login_design_final.md

常见问题¶

Q: 如何找到特定功能的文档？¶

A: 按功能模块查找，例如登录功能在 LOGIN/ 文件夹中。

Q: 文档过期了怎么办？¶

A: 将其移入 docs/02-archived/，并在 ARCHIVE_LOG.md 中添加记录。

Q: 如何追踪文档变更历史？¶

A: 查看文档顶部的版本历史，或查看 git 提交记录。

Q: 代码与文档不一致怎么办？¶

A: 优先更新文档，然后更新代码，确保文档是真实来源。

最后更新¶

📅 2026-03-15 👤 Claude