project-summary

Generate a structured project summary in docs/PROJECT_SUMMARY.md for a codebase.

Updated Mar 18, 2026
One-click install
npx skills add https://github.com/abogoyavlensky/agents --skill project-summary-abogoyavlensky
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-summary
Source: https://github.com/abogoyavlensky/agents/tree/main/skills/project-summary
Command: npx skills add https://github.com/abogoyavlensky/agents --skill project-summary-abogoyavlensky

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps developers quickly generate a LLM-friendly project summary for a codebase by analyzing the repository structure and existing documentation, producing a single, coherent overview.

Core Features & Use Cases

  • Read and reuse an existing docs/PROJECT_SUMMARY.md when present.
  • Analyze key files, dependencies, and structure to produce a comprehensive summary.
  • Create or update docs/PROJECT_SUMMARY.md with sections describing the project purpose, architecture, workflows, and extension points to aid future development.

Quick Start

Ask the agent to generate a summary for the current repository to have an up-to-date PROJECT_SUMMARY.md.

Frequently Asked Questions about project-summary

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

FAQPage Schema
How do I generate an LLM-friendly project summary for my codebase?

To generate an LLM-friendly project summary, the skill analyzes your repository structure and existing documentation to create a comprehensive overview in docs/PROJECT_SUMMARY.md. It reuses existing summary files when present and updates them with the required project architecture and workflow details.

What is the best way to document codebase architecture for a coding assistant?

Documenting codebase architecture for a coding assistant requires a structured summary covering the project purpose, architecture, workflows, and extension points. This skill produces that exact structure in docs/PROJECT_SUMMARY.md, helping an LLM understand the project quickly with minimal extra context needed.

Can I update an existing project summary without losing the manual documentation I added?

Yes, you can update an existing project summary without losing your structure because the skill reads the current docs/PROJECT_SUMMARY.md if present. It analyzes key files and dependencies to create or update the file while maintaining the comprehensive overview required by coding assistants.

Do I need to manually select files for generating project documentation?

No, you do not need to manually select files for generating project documentation. The skill automatically analyzes key files, dependencies, and the repository structure to produce a comprehensive, structured summary that helps a coding assistant understand the project quickly.

What sections are included in an LLM-friendly project overview?

An LLM-friendly project overview includes sections describing the project purpose, architecture, workflows, and extension points. This structure is written to docs/PROJECT_SUMMARY.md to aid future development and help a coding assistant understand the project quickly with minimal extra context.