Prompt file imported from MohammadBafkar/Roadmaps (
.github/prompts/summarize-roadmap.prompt.md). Fill in{{arguments}}before use. Copyright stays with the author.
Generate a quick-reference cheatsheet and interview prep guide for an existing roadmap (reference artifact, not a learning tool)
Mode: Content Creation — provide complete, production-ready examples. Do NOT use hint escalation.
Note: This skill generates a reference artifact (
quick-reference.md). It is useful for review, interview prep, and triage, but it is NOT a substitute for active learning. For retrieval-based learning, use memory sheets (_progress/memory-sheets/) which the learner fills from memory.
Generate a comprehensive quick-reference.md file for {{arguments}} that serves as a cheatsheet, interview preparation guide, and condensed reference for the specified roadmap.
Pre-conditions
- Only proceed if a roadmap already exists for the target topic; otherwise, suggest using
new-roadmapfirst. - Check {{arguments}} for any user-specified focus areas, interview level (junior/mid/senior/staff), or specific sections to prioritize.
- The output file must be named
quick-reference.mdand placed in the root of the target roadmap directory. - Review all files in the roadmap to extract the most important concepts, patterns, and interview-worthy content.
- If
quick-reference.mdalready exists, intelligently merge new content without duplicating existing information and complete any missing sections.
Output Structure
The quick-reference.md file should include these sections (adapt per topic type):
- At a Glance - One-paragraph summary + key facts table
- Core Concepts - 5-10 essential concepts with one-liner definitions and mental models
- Syntax Cheatsheet - Most common syntax/commands/APIs
- Common Patterns - 5-8 most important patterns with minimal working examples
- Best Practices - Table of practices with reasons and examples
- Anti-Patterns to Avoid - Table of anti-patterns with problems and solutions
- Interview Questions - 15-25 questions across beginner/intermediate/advanced/senior levels
- Quick Commands / APIs - Most used commands and configuration settings
- Troubleshooting Guide - 5-10 most common issues with symptoms, causes, and fixes
- Key Comparisons - Topic vs alternatives with decision criteria
- Resources - Official docs, learning resources, community links
Section Adaptation by Topic Type
| Topic Type | Include | Modify |
|---|---|---|
| Programming Language | Syntax Cheatsheet, Core Concepts | Quick Commands -> Standard Library |
| Framework | Common Patterns, Configuration | Syntax -> Component APIs |
| Tool (CLI) | Quick Commands, Troubleshooting | Syntax Cheatsheet -> Command Reference |
| Architecture Pattern | Core Concepts, Comparisons | Syntax Cheatsheet -> Implementation Patterns |
| Cloud Service | Quick Commands, Configuration | Syntax -> Service APIs |
Content Guidelines
Include
- Concepts that appear across multiple roadmap files (high importance)
- Patterns and practices emphasized in the roadmap
- Common gotchas and mistakes highlighted in the roadmap
- Syntax/commands used frequently in examples
- Interview questions from practice sections
- Trade-offs and comparisons mentioned in the roadmap
Exclude
- Lengthy explanations (that's what the roadmap is for)
- Obscure features rarely used in practice
- Historical context unless interview-relevant
- Setup/installation details (keep in main roadmap)
- Full project walkthroughs
Quality Checklist
- All major concepts from the roadmap are represented
- Code examples are syntactically correct and runnable
- Interview questions cover beginner to advanced levels
- Tables are properly formatted
- All internal links to roadmap files are correct
- No section exceeds reasonable length (this is a cheatsheet)
- Follows
.ai/guidelines/markdown.mdformatting