project-teacher

Generate structured learning documentation with code index and version history.

Updated Mar 16, 2026
One-click install
npx skills add https://github.com/cgm-free/ai-education-platform --skill project-teacher
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-teacher
Source: https://github.com/cgm-free/ai-education-platform/tree/main/.agents/skills/project-teacher
Command: npx skills add https://github.com/cgm-free/ai-education-platform --skill project-teacher

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams and learners convert hands-on projects into structured learning resources, capturing rationale, decisions, and key insights to support knowledge transfer and future reuse.

Core Features & Use Cases

  • Generate a detailed project explanation focusing on the "why" and "how" to aid understanding.
  • Create a learning retrospective that documents architecture, decisions, trade-offs, and lessons learned for future reference.
  • Sync and version learning documents by checking for existing outputs, updating metadata, and preserving history.

Quick Start

Create a learning document for the current project in the learning/ directory.

Frequently Asked Questions about project-teacher

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

FAQPage Schema
How do I generate learning documentation from an existing project codebase?

To generate learning documentation, you create a learning retrospective that analyzes your project codebase to produce a structured outline. This includes a code index, architecture overview, key decisions, and trade-offs for knowledge transfer.

What is a project learning retrospective and when do I need one?

A project learning retrospective is a structured document capturing what was built, why it was built, and how to maintain it. You need one when converting hands-on projects into reusable learning resources for future reference.

Can I automatically document architecture and key decisions for knowledge transfer?

Yes, you can automatically document architecture and key decisions by generating a structured learning resource. This process captures rationale, trade-offs, and lessons learned to support team knowledge transfer and future reuse.

How do I sync and version learning documents without losing history?

To sync and version learning documents, the system checks for existing outputs, updates metadata, and preserves version history. This ensures your reproducible, versioned learning resources remain current without losing previous documentation.

Does generating a project retrospective require any external dependencies?

Generating a project retrospective requires no external dependencies. The process directly analyzes your current project to create structured documentation focusing on the why and how of your architecture and logic.

What is the best way to outline project explanation and reflection questions?

The best way to outline project explanations and reflection questions is using a structured learning document. This includes a project overview, code index, architecture logic, key decisions, version history, and targeted reflection questions.