Guide de rédaction des feuilles de route

VérifiéSûr

S'applique lors de l'édition, la mise à jour ou la maintenance de roadmap.md. Impose des règles de concision (supprimer les redondances, limiter les paragraphes), une structure d'entrée de version, des tableaux de comparaison et des listes d'interdictions. Utile pour garder les documents roadmap clairs et à haute densité d'information.

Spar Skills Guide Bot
DocumentationIntermédiaire
16002/06/2026
Claude CodeCursorWindsurfCopilotCodex
#roadmap#documentation#best-practices#maintenance#writing

Recommandé pour

Notre avis

Cette compétence fournit des directives pour rédiger et maintenir un fichier roadmap.md, en mettant l'accent sur la concision, les entrées de version structurées, les tableaux de comparaison et les diagrammes ASCII.

Points forts

  • Impose la concision et évite la redondance dans la documentation de la feuille de route.
  • Fournit une structure claire avec des entrées de version, des indicateurs de statut et des tableaux de comparaison.
  • Inclut des règles sur ce qu'il ne faut pas inclure, évitant ainsi la dérive du périmètre.
  • Recommande des diagrammes ASCII pour une représentation visuelle.

Limites

  • Peut être trop rigide pour des projets simples ou personnels.
  • Ne couvre pas les outils ou l'automatisation de la feuille de route.
  • Se concentre uniquement sur le format Markdown, pas sur d'autres supports de documentation.
Quand l'utiliser

Utilisez cette compétence lors de la création ou de la mise à jour d'un fichier roadmap.md pour garantir qu'il reste concis, informatif et facile à maintenir.

Quand l'éviter

Ne l'utilisez pas pour des feuilles de route très simples où la brièveté n'est pas une préoccupation, ou lorsqu'une feuille de route plus narrative est préférée.

Analyse de sécurité

Sûr
Score qualité88/100

This skill only provides documentation formatting guidelines for a roadmap.md file. It does not involve executing any commands, accessing external resources, or handling sensitive data.

Aucun point d'attention détecté

Exemples

Draft roadmap for v1.2
Help me draft a roadmap for version 1.2 of my project following the roadmap guide. Include core objective, implementation scope (with checkboxes for completed and pending items), and a section for things we won't do.
Update roadmap status and add comparison table
Update the roadmap.md with the latest status: set v0.5.0 as completed and v0.5.1 as in progress. Add a comparison table between v0.5.0 and v0.5.1 covering dimensions like call rounds and decision mode.
Review and apply conciseness principle
Review my current roadmap.md and apply the conciseness principle: remove any redundant code examples, long paragraphs (over 3 lines), and duplicate information. Replace with lists or tables where appropriate.

name: roadmap-guide description: 在编写、更新、维护 roadmap.md 的时候触发

Roadmap 编写指南

核心原则:roadmap 是导航图,不是教科书。信息密度 > 详细程度。

When to use

必须应用此规范的场景:

  • docs/roadmap.md 添加新版本/功能
  • 更新已有版本的状态
  • 记录架构决策的理由
  • 标记禁止事项和数据源限制

1. 简洁性原则(CRITICAL)

❌ 禁止冗余

删除这些内容:

  1. 示例代码(除非必需理解问题)

    ❌ 错误:
    **实现方案:**
    ```python
    # 20 行完整代码示例
    async def chat_with_loop(self, query: str) -> str:
        for i in range(15):
            ...
    

    ✅ 正确: 实现方案: chat_with_loop() 方法,最多 15 轮 ReAct 循环

  2. 重复信息(已在其他文档详述)

    ❌ 错误:详细解释 T+1/T+2 确认规则
    ✅ 正确:确认规则见 `docs/settlement-rules.md`
    
  3. 过长段落

    ❌ 错误:超过 3 行的描述段落
    ✅ 正确:每段 ≤ 3 行,优先使用列表/表格
    

2. 版本条目结构

每个版本条目遵循固定结构:

## vX.Y.Z 版本标题(状态标记)

### 核心目标
一句话说明此版本解决什么问题。

### 实现范围
- [x] 已完成项
- [ ] 待完成项

### 不做
- ❌ 明确排除的功能(防止范围蔓延)

状态标记

  • 已完成
  • 🚧 进行中
  • 🔮 规划中

3. 对比表格

版本间对比使用表格,清晰展示差异:

| 维度 | v0.5.0 | v0.5.1 |
|------|--------|--------|
| 调用轮数 | 固定 1-2 轮 | 动态 N 轮 |
| 决策模式 | 一次性决定 | 边做边决策 |

4. 禁止事项 & 限制

使用统一格式记录:

## 禁止事项
- ❌ AI 执行交易操作(只给建议)
- ❌ 修改数据库 Schema

## 已知限制
**限制名称**(记录日期):
- 问题描述(1-2 行)
- 未来方案(可选)

5. ASCII 图表

架构/数据流优先使用 ASCII 图:

导入阶段:
  CSV → 算法 → BillFacts → AI 判断 → 回填 ActionLog

分析阶段:
  用户提问 → AI → Tools → 分析 → 建议

6. 触发机制

自动触发: 当检测到以下操作时,自动应用此 skill

  • 文件路径包含 roadmap.md
  • 提交信息包含 "roadmap" / "版本" / "规划"
  • 用户明确要求更新 roadmap

提醒文案:

正在编辑 roadmap.md
请遵循简洁性原则:
- 每段 ≤ 3 行
- 代码示例 ≤ 5 行或删除
- 无重复信息
- 优先使用列表/表格

Skills similaires