skills.rest
ThejanaJayalath
ThejanaJayalathCOMMUNITY
Explore all skills by this author →
GitHub

code-tour

Generate structured CodeTour JSON files for guided codebase navigation.

Updated Jan 30, 2026
Search Tags:#architecture#documentation#onboarding#codebase#walkthrough#codetour
One-click install
npx skills add https://github.com/ThejanaJayalath/Niolla-PM-system --skill code-tour-thejanajayalath
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-tour
Source: https://github.com/ThejanaJayalath/Niolla-PM-system/tree/main/.cursor/skills/code-tour
Command: npx skills add https://github.com/ThejanaJayalath/Niolla-PM-system --skill code-tour-thejanajayalath

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the difficulty of onboarding new engineers or explaining complex architectural changes by providing a structured, step-by-step navigation path through the codebase.

Core Features & Use Cases

  • Guided Walkthroughs: Generates CodeTour JSON artifacts that anchor to specific files and lines.
  • Persona-Targeted Narratives: Tailors the depth and focus of the tour based on the reader, such as new joiners, PR reviewers, or security auditors.
  • Use Case: When a new developer joins the team, use this Skill to create a tour that guides them from the entry point through the core service layer and into the database integration logic.

Quick Start

Use the code-tour skill to generate a new-joiner tour that explains the project structure and the main request execution path.

Frequently Asked Questions about code-tour

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create guided code walkthroughs for onboarding new developers?▼

Create guided code walkthroughs by generating structured CodeTour JSON files that anchor narrative steps to specific file paths and line ranges. This provides step-by-step navigation through complex codebases to facilitate onboarding and architectural explanations.

What is the SMIG framework for codebase documentation?▼

The SMIG framework structures codebase documentation by ensuring descriptions provide situation, mechanism, implication, and gotcha context. It targets specific reader personas like new joiners or security auditors to tailor the depth and focus of code walkthroughs.

Can I tailor code walkthrough narratives for different reviewer personas?▼

Yes, you can tailor code walkthrough narratives for different reviewer personas. The generated tours adjust depth and focus based on the target reader, such as new joiners needing structural overviews or PR reviewers requiring focused architectural change explanations.

How do I anchor documentation steps to specific files and line ranges?▼

Anchor documentation steps to specific files and line ranges by generating structured CodeTour JSON artifacts. These artifacts map narrative descriptions directly to exact file paths and line numbers within the codebase for precise guided navigation.

What is the best way to document architectural changes for pull request reviews?▼

The best way to document architectural changes for pull request reviews is generating persona-targeted CodeTour JSON files. These files provide guided, step-by-step navigation anchored to specific file paths and line ranges to explain modifications clearly to reviewers.

Related Skills

Explore More Software Engineering Skills→
vrcmsvrcms
1

code-tour

Generate structured CodeTour JSON artifacts anchored to file paths and line ranges.

Community
Intermediate
Patasse97Patasse97

code-tour

Create CodeTour walkthroughs anchored to specific files and lines.

Community
Advanced
529-studio529-studio
2

code-tour

Generate structured CodeTour JSON artifacts for guided codebase navigation.

Official
Intermediate
abhishekdutta18abhishekdutta18

code-tour

Generate interactive CodeTour .tour files anchored to verified file lines.

Community
Intermediate