modscape-spec-requirements

Gathers business requirements interactively and generates spec.md files for data pipelines.

Updated Feb 25, 2026
One-click install
npx skills add https://github.com/yujikawa/modscape --skill modscape-spec-requirements-yujikawa
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: modscape-spec-requirements
Source: https://github.com/yujikawa/modscape/tree/main/src/templates/gemini/modscape-spec-requirements
Command: npx skills add https://github.com/yujikawa/modscape --skill modscape-spec-requirements-yujikawa

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Data pipeline projects often fail because business context, table relationships, and acceptance criteria are never captured in a structured, version-controlled form. This Skill guides an interactive requirements-gathering conversation and writes the results into a standardized spec.md under .modscape/changes/<name>/. ## Core Features & Use Cases - Interactive Requirements Elicitation: Collects pipeline title, goal, stakeholders, data sources, table relationships, acceptance criteria, and target tool (dbt, SQLMesh, Spark SQL, plain SQL) through structured conversation. - Business Context Capture: Probes for tacit knowledge about how data is generated, domain-specific rules, and edge cases that cannot be derived from schemas alone. - Traceability Artifacts: Generates spec.md, glossary.md, and questions.md with answered, assumed, and open questions, plus PII-safe investigation queries for ambiguous metrics. - Use Case: A data engineer starting a new dbt pipeline uses this Skill to interview stakeholders, document join keys and cardinality between source tables, and produce a spec.md ready for the design phase. ## Quick Start Ask the AI to gather requirements for a new data pipeline using @modscape-spec-requirements and answer its questions about sources, goals, and acceptance criteria.

Frequently Asked Questions about modscape-spec-requirements

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

FAQPage Schema
How do I gather requirements for a dbt data pipeline?▼

Invoke @modscape-spec-requirements and answer its structured questions about pipeline goal, stakeholders, data sources, table relationships, and acceptance criteria. It writes the results to .modscape/changes/<name>/spec.md and scaffolds design.md and tasks.md for the next phase.

What is a spec.md file in Modscape?▼

spec.md is a requirements document stored under .modscape/changes/<name>/ that records the pipeline goal, stakeholders, data sources, table relationships, acceptance criteria with sequential IDs, and business context. It follows the template defined in .modscape/formats/spec-format.md.

Does modscape-spec-requirements work with SQLMesh or Spark SQL?▼

Yes, the target tool setting supports dbt, SQLMesh, Spark SQL, and plain SQL. You can set a project-wide default in modscape-spec.custom.md so the Skill skips asking about the target tool in every session.

How does the Skill avoid asking questions already answered?▼

It reads .modscape/modscape-spec.custom.md first and treats any settings defined there, such as main YAML paths or target tool, as already answered. Rules in that file take priority over the default instructions when they conflict.

Why does the Skill generate investigation queries in questions.md?▼

When it detects ambiguous metrics, unconfirmed join keys, or unclear timestamp semantics, it records an open question with a PII-safe aggregate-only query. A human reviews and runs the query, then records the finding to resolve analytical ambiguity before implementation.

What happens if the changes folder already exists?▼

The Skill warns that .modscape/changes/<name>/ already exists and asks for a different name. If only spec.md exists, it shows the current content and asks what to update instead of overwriting it.