overview-spec

Generate a system overview specification from a project plan.

1|Updated Feb 20, 2026
One-click install
npx skills add https://github.com/jamesaphoenix/tx-agent-kit --skill overview-spec
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: overview-spec
Source: https://github.com/jamesaphoenix/tx-agent-kit/tree/main/.claude/skills/overview-spec
Command: npx skills add https://github.com/jamesaphoenix/tx-agent-kit --skill overview-spec

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate a system overview specification from a project plan to ensure consistent architecture narratives and traceable planning.

Core Features & Use Cases

  • Scaffold a full system overview document (architecture, data flows, scope, and non-goals) from a plan.
  • Reference the plan path in frontmatter and link to the living plan for traceability.
  • Produce a specs/<name>.md with tx-managed frontmatter and an organized narrative suitable for architecture reviews.

Quick Start

Provide a project context and run the overview workflow to generate the specs at specs/<name>.md.

Frequently Asked Questions about overview-spec

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

FAQPage Schema
How do I generate a system overview spec from a project plan?

Generate a system overview spec by applying the tx doc workflow to an existing project plan, producing a structured specs/<name>.md with architecture, data flows, scope, and non-goals sections.

What should a system architecture specification document include?

A system architecture specification should include the problem statement, architecture overview, components, data flows, scope, non-goals, and risks, all structured with tx-managed frontmatter for traceability.

How do I link my architecture spec to a living project plan?

Link an architecture spec to a living plan by referencing the plan path in the document frontmatter and including a Plan section that points to ~/.claude/plans/<name>.md for traceable planning.

Can I scaffold architecture documentation automatically from an existing plan?

Scaffold architecture documentation automatically by running the overview workflow with project context, which generates a full narrative document suitable for architecture reviews from your plan file.

What is the tx doc workflow for system design specifications?

The tx doc workflow scaffolds system design specifications by transforming a project plan into a structured overview document, applying managed frontmatter and organized architecture narratives for consistent documentation.

Do I need an existing project plan before generating a system overview specification?

An existing project plan is required before generating a system overview specification, as the workflow references the plan path in frontmatter and derives the architecture, data flows, and scope directly from it.