28 lines
1.3 KiB
Markdown
28 lines
1.3 KiB
Markdown
---
|
|
name: doc_refresher
|
|
description: 自动同步和刷新项目文档，确保 Markdown 文件与当前代码功能状态完全一致。
|
|
---
|
|
|
|
# Documentation Refresher Skill
|
|
|
|
此技能用于在项目架构发生重大调整（如功能下线、重心转移）后，自动重写和更新项目的所有 Markdown 文档。
|
|
|
|
## 核心任务
|
|
|
|
1. **代码扫描**：分析 `run.py` 和核心逻辑，识别哪些功能是“活跃的”，哪些功能是“暂停/移除的”。
|
|
2. **术语统一**：确保所有文档使用一致的语气（例如从“监控机器人”转向“天气查询机器人”）。
|
|
3. **多语言同步**：确保 `_ZH.md` 与英文版文档内容同步。
|
|
|
|
## 更新准则
|
|
|
|
- **状态准确性**：如果功能已在代码中被注释（如监控引擎、模拟交易），文档必须明确标注为“已暂停”或直接移除。
|
|
- **示例更新**：更新文档中的 Telegram 指令示例，移除已下线的指令（如 `/signal`, `/portfolio`）。
|
|
- **流程简化**：针对当前“天气查询模式”，简化安装和运行流程说明。
|
|
|
|
## 使用流程
|
|
|
|
1. 查看 `run.py` 确认当前运行模式。
|
|
2. 遍历项目根目录下所有的 `.md` 文件。
|
|
3. 对每个文件内容进行重构，保持格式美观。
|
|
4. 校验多语言版本的一致性。
|