roadmap-guide_skill

Overview

This skill provides clear, opinionated guidance and automatic checks for writing and updating docs/roadmap.md files. It enforces concise roadmap entries, a fixed version-entry structure, and standardized sections for exclusions and limitations. The goal is to keep roadmaps high-level, navigable, and consistent across releases.

How this skill works

The skill detects edits to files named roadmap.md, commit messages containing roadmap/版本/规划, or explicit user requests to update a roadmap. It then suggests or enforces the roadmap writing rules: short paragraphs, minimal code, version entry templates, comparison tables, ASCII diagrams, and a forbidden-items section. It can also insert a short reminder banner when a roadmap file is edited.

When to use it

• Adding a new version or feature entry to docs/roadmap.md
• Updating the status or scope of an existing version entry
• Documenting reasons for architecture or design decisions tied to a release
• Recording explicit exclusions (“do not do”) or data-source limitations
• When a commit or PR mentions roadmap, version, or planning keywords

Best practices

• Keep each paragraph to three lines or fewer; prefer lists or tables
• Remove full code samples; replace with a short descriptor or ≤5-line snippet if essential
• Avoid repeating information available in other docs; link to them instead
• Follow the version-entry template: title+status, core goal, scope checklist, exclusions
• Document limitations and banned actions in a dedicated section with dates

Example use cases

• Add v1.2.0 entry: set core goal, check completed vs pending items, mark status 🚧
• Update an existing entry from 🔮 to ✅ and move completed items to the checklist
• Record a forbidden action such as ‘no automated trading’ under the prohibited list
• Create a short ASCII data-flow diagram for an import or analysis stage
• Replace long code blocks with a one-line implementation summary linked to an internal doc