Overview

Generate a 60-80 line project overview from spec.md and arch.md.

1|Updated Jan 30, 2026
One-click install
npx skills add https://github.com/samdae/archflow --skill overview-samdae
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Overview
Source: https://github.com/samdae/archflow/tree/main/skills/overview
Command: npx skills add https://github.com/samdae/archflow --skill overview-samdae

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the creation of a concise, 60-80 line project overview from a team's requirements and architecture documents, helping onboarding and stakeholder alignment without duplicating details.

Core Features & Use Cases

  • Automated Summary: Generates a readable overview that synthesizes requirements (spec.md) and architecture (arch.md) into a single document.
  • Diagrams & Links: Embeds architecture, ERD, and key flow diagrams while pointing to detailed docs for deeper dives.
  • Onboarding & Quick Handoffs: Produces a 1-page briefing suitable for new team members and cross-functional stakeholders.
  • Length & Focus Constraints: Adheres to 60-80 line output with 80-120 lines maximum including diagrams, excluding mermaid blocks.

Quick Start

To generate an overview, ensure the source docs exist at docs/{serviceName}/spec.md and docs/{serviceName}/arch.md, then trigger the Overview skill with the "overview" or "project overview" command. The generated file will be written to docs/{serviceName}/overview.md and can be reviewed and adjusted as needed.

Frequently Asked Questions about Overview

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

FAQPage Schema
How do I generate a project overview from spec and architecture docs for onboarding?

To generate a project overview, the skill synthesizes requirements from spec.md and architecture details from arch.md into a concise overview.md. It targets onboarding and stakeholder briefings by producing a 60-80 line summary with embedded diagrams and links.

What is the best way to summarize architecture and requirements documents for stakeholder briefings?

The best way to summarize architecture and requirements documents is to synthesize spec.md and arch.md into a single 1-page overview. This approach embeds architecture, ERD, and key flow diagrams while pointing to detailed docs for deeper dives.

Do I need specific markdown files to create a concise project handoff document?

Yes, you need specific markdown files to create a project handoff document. The skill reads docs/{serviceName}/spec.md and docs/{serviceName}/arch.md, then writes a concise 60-80 line overview.md with diagrams for team handoffs.

Does the generated project overview include architecture and flow diagrams?

Yes, the generated project overview includes architecture, ERD, and key flow diagrams. It embeds these diagrams within the 60-80 line summary while excluding mermaid blocks from the maximum 80-120 line count.

What are the length limitations when generating an overview from markdown documentation?

Length limitations for generating an overview mandate a 60-80 line output with a maximum of 80-120 lines including diagrams. Mermaid blocks are excluded from this constraint to allow detailed architecture visualization.