shanxi-resilience-doc-updater

name	shanxi-resilience-doc-updater
description	陕交控项目专用文档更新工具 - 自动更新会话记录、业务逻辑记录、表口径总表等项目文档，保持文档与代码同步

陕交控项目文档更新工具

专门用于陕交控多路段改扩建韧性提升项目的文档维护工作。

核心功能

1. 会话记录更新

自动更新 docs/会话记录与搭建过程.md：

• 添加新的会话阶段
• 记录已完成的工作
• 更新项目状态清单
• 记录遇到的问题和解决方案

2. 业务逻辑记录

维护 docs/业务逻辑记录.md：

• 添加新的业务逻辑条目（BL-00x）
• 记录业务描述、处理逻辑
• 提供伪代码和 SQL 示例
• 关联相关表和字段

3. 表口径登记

更新表口径总表：

• 登记新创建的表
• 记录表用途、粒度、主键
• 说明来源和下游使用模块
• 关联字段字典

4. 项目状态维护

更新 .Codex/memory/MEMORY.md：

• 记录项目当前状态
• 跟踪已完成的工作
• 列出待完成任务
• 记录关键决策和架构选择

文档结构

会话记录结构

## 第{N}阶段：{阶段名称}

### 第{N}步：{步骤名称}

**用户请求**:
> "{用户原文}"

**我的响应**:
- {响应内容}

---

### 实现结果

#### 1. 创建的文件
| 文件 | 说明 |
|------|------|
| {path} | {description} |

#### 2. 数据导入结果
| 统计项 | 数值 |
|--------|------|
| {key} | {value} |

---

### 最终项目状态

### ✅ 已完成的工作清单
- [x] {task1}
- [x] {task2}

### 📋 待完成工作（下一步）
- [ ] {task1}
- [ ] {task2}

业务逻辑记录结构

---
## BL-00{x}: {业务逻辑名称}

**创建日期**: 2026-04-13
**相关模块**: M{N}
**相关表**: {table1}, {table2}

### 业务描述
{详细描述业务逻辑的用途和背景}

### 处理逻辑
1. {步骤1}
2. {步骤2}
3. {步骤3}

### 伪代码
```python
def {function_name}({params}):
    {implementation}

SQL 示例

-- {SQL描述}
SELECT {columns}
FROM {table}
WHERE {conditions};

关键字段说明

字段名	说明
{field}	{description}

### 表口径登记结构

{表名}

属性	值
表用途	{description}
粒度	{grain}
主键	{pk}
来源	{source}
下游使用模块	{modules}

字段字典

字段名	数据类型	说明
{field}	{type}	{description}

## 使用示例

### 更新会话记录
```bash
skill: shanxi-resilience-doc-updater
args: "session --stage '收费路段数据导入' --step '数据分析与导入'"

添加业务逻辑

skill: shanxi-resilience-doc-updater
args: "business-logic --name '判断是否交控集团' --module M0"

登记表口径

skill: shanxi-resilience-doc-updater
args: "table-registry --table dim_toll_road --layer dim"

更新项目记忆

skill: shanxi-resilience-doc-updater
args: "memory --status '完成收费路段数据导入'"

文档更新检查清单

会话记录

• 阶段标题正确
• 用户请求原文引用
• 响应内容简洁明了
• 创建的文件列表完整
• 数据导入结果准确
• 已完成工作清单更新
• 待完成工作清单合理

业务逻辑记录

• 编号连续（BL-001, BL-002...）
• 业务描述清晰
• 处理逻辑步骤完整
• 伪代码可执行
• SQL 示例正确
• 关键字段说明完整

表口径登记

• 表用途说明清楚
• 粒度定义准确
• 主键字段正确
• 来源说明明确
• 下游使用模块列出
• 字段字典完整

项目记忆

• 当前状态准确
• 已完成工作记录完整
• 待完成任务优先级合理
• 关键决策记录在案
• 架构选择说明清楚

文档位置

文档	路径	说明
数据表说明	docs/数据表说明.md	⭐ 所有表的权威说明文档，含连接信息、数据字典、查询示例
会话记录	docs/会话记录与搭建过程.md	完整的会话和工作记录
业务逻辑记录	docs/业务逻辑记录.md	业务逻辑和算法说明
表口径总表	docs/表口径总表.md	所有表的口径登记
项目记忆	.Codex/memory/MEMORY.md	项目状态和关键信息
使用指南	README_USE_GUIDE.md	项目使用指南

数据表说明.md 更新规范

新建表后必须同步更新 docs/数据表说明.md，具体步骤：

1. 更新顶部日期（第3行 > 更新日期：YYYY-MM-DD）

2. 更新表清单总览（按字母序插入新行）：

| [新表名](#N-新表名) | DIM/DWD/DWS/ADS | 简介 | 记录数 |

并将后续表的锚点编号依次 +1。

3. 插入详细章节（在对应位置插入）：

### N. 新表名

**简介**：...

**主键**：...

#### 数据字典

| 字段名 | 类型 | 可空 | 描述 |
|--------|------|------|------|

#### 查询示例

```sql
SELECT ...

4. **后续章节标题编号** 依次 +1。

## 自动更新触发点

### 数据导入后
- 更新会话记录
- 登记表口径
- 更新项目记忆

### 表结构变更后
- 更新表口径总表
- 更新字段字典
- 记录变更原因

### 业务逻辑实现后
- 添加业务逻辑记录
- 提供 SQL 示例
- 关联相关表

### 阶段完成后
- 更新会话记录
- 更新已完成工作清单
- 列出下一步任务