Best use case
roadmap-guide is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
在编写、更新、维护 roadmap.md 的时候触发
Teams using roadmap-guide should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/roadmap-guide/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How roadmap-guide Compares
| Feature / Agent | roadmap-guide | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
在编写、更新、维护 roadmap.md 的时候触发
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# Roadmap 编写指南
> **核心原则**：roadmap 是导航图，不是教科书。信息密度 > 详细程度。
## When to use
**必须应用**此规范的场景：
- 向 `docs/roadmap.md` 添加新版本/功能
- 更新已有版本的状态
- 记录架构决策的理由
- 标记禁止事项和数据源限制
---
## 1. 简洁性原则（CRITICAL）
### ❌ 禁止冗余
**删除这些内容：**
1. **示例代码**（除非必需理解问题）
```markdown
❌ 错误：
**实现方案：**
```python
# 20 行完整代码示例
async def chat_with_loop(self, query: str) -> str:
for i in range(15):
...
```
✅ 正确：
**实现方案：** `chat_with_loop()` 方法，最多 15 轮 ReAct 循环
```
2. **重复信息**（已在其他文档详述）
```markdown
❌ 错误：详细解释 T+1/T+2 确认规则
✅ 正确：确认规则见 `docs/settlement-rules.md`
```
3. **过长段落**
```markdown
❌ 错误：超过 3 行的描述段落
✅ 正确：每段 ≤ 3 行，优先使用列表/表格
```
---
## 2. 版本条目结构
每个版本条目遵循固定结构：
```markdown
## vX.Y.Z 版本标题（状态标记）
### 核心目标
一句话说明此版本解决什么问题。
### 实现范围
- [x] 已完成项
- [ ] 待完成项
### 不做
- ❌ 明确排除的功能（防止范围蔓延）
```
**状态标记**：
- `✅` 已完成
- `🚧` 进行中
- `🔮` 规划中
---
## 3. 对比表格
版本间对比使用表格，清晰展示差异：
```markdown
| 维度 | v0.5.0 | v0.5.1 |
|------|--------|--------|
| 调用轮数 | 固定 1-2 轮 | 动态 N 轮 |
| 决策模式 | 一次性决定 | 边做边决策 |
```
---
## 4. 禁止事项 & 限制
使用统一格式记录：
```markdown
## 禁止事项
- ❌ AI 执行交易操作（只给建议）
- ❌ 修改数据库 Schema
## 已知限制
**限制名称**（记录日期）：
- 问题描述（1-2 行）
- 未来方案（可选）
```
---
## 5. ASCII 图表
架构/数据流优先使用 ASCII 图：
```markdown
导入阶段：
CSV → 算法 → BillFacts → AI 判断 → 回填 ActionLog
分析阶段：
用户提问 → AI → Tools → 分析 → 建议
```
---
## 6. 触发机制
**自动触发：** 当检测到以下操作时，自动应用此 skill
- 文件路径包含 `roadmap.md`
- 提交信息包含 "roadmap" / "版本" / "规划"
- 用户明确要求更新 roadmap
**提醒文案：**
```
正在编辑 roadmap.md
请遵循简洁性原则：
- 每段 ≤ 3 行
- 代码示例 ≤ 5 行或删除
- 无重复信息
- 优先使用列表/表格
```
---Related Skills
components-guide
Guide to using Convex components for feature encapsulation. Learn about sibling components, creating your own, and when to use components vs monolithic code.
clack-guidelines
Comprehensive guide for building beautiful interactive command-line interfaces using Clack. Use when creating CLI tools with text input, selections, autocomplete, progress tracking, and streaming output.
astrology-interpretation-guide
Comprehensive astrology expert covering natal charts, transits, houses, aspects, and astrological traditions from Western to Vedic
Arcanea Voice Guide
Brand voice and terminology guide for all Arcanea content - ensures consistent, magical communication across UI, marketing, and narrative
analytic-skills-guide
Guide for AI agent to use the tools offered by this library to perform analytic tasks.
ai-engineering-guide
Practical guide for building production ML systems based on Chip Huyen's AI Engineering book. Use when users ask about model evaluation, deployment strategies, monitoring, data pipelines, feature engineering, cost optimization, or MLOps. Covers metrics, A/B testing, serving patterns, drift detection, and production best practices.
agents-md-guidelines
Guidelines for writing small, stable AGENTS.md files. Use when creating, refactoring, or reviewing AGENTS.md.
agent-ops-guide
Interactive workflow guide. Use when user is unsure what to do next, needs help navigating AgentOps, or wants to understand available tools.
agent-guidelines
When you need to understand the project's core mandate, operational rules, or "Constitution". Use this skill to align with the project's identity and strict coding standards.
ADAPTATION_GUIDE
Use when adapting Droidz framework or creating custom workflows. Guide for customizing droids, skills, and commands for specific project needs.
5-styleguide-generation
Fifth step in building instruction context for codebase
security-skills-guide
Guide for security-related Agent Skills including penetration testing, code auditing, threat hunting, and forensics skills.