skills.rest
ForgePlan
ForgePlanOFFICIAL
Explore all skills by this author →
WebsiteGitHub

canonical-reproducer

Generate canonical DDL, pseudo-code, and SDL documentation from code artifacts.

3|Updated Apr 3, 2026
Search Tags:#document generation#code documentation#canonical form#software domain#Factum integration
One-click install
npx skills add https://github.com/ForgePlan/marketplace --skill canonical-reproducer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: canonical-reproducer
Source: https://github.com/ForgePlan/marketplace/tree/main/plugins/forgeplan-brownfield-pack/skills/canonical-reproducer
Command: npx skills add https://github.com/ForgePlan/marketplace --skill canonical-reproducer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires C1-C9, Template Engine, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill addresses the challenge of documentation that references specific code lines, which can break when code is moved or deleted. It transforms verified knowledge into a self-contained, canonical form that survives code changes.

Core Features & Use Cases

  • Self-contained Documents: Generates standalone DDL, pseudo-code, SDL, and other documents without file:line references.
  • Domain-Specific Outputs: Provides domain overview, schema, API, pseudo-code, scenarios, glossary, invariants, and use-cases.
  • Modes: Offers modes to render all domains, render a single domain, or compare rendered documents to source artifacts.
  • Integration with Factum: Uses schema evolution history and GraphQL type datasets from Factum.

Quick Start

To generate documentation for a specific domain, run: /canonical-reproducer render-domain --domain <domain_name>

Frequently Asked Questions about canonical-reproducer

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

FAQPage Schema
How do I generate code documentation that doesn't break when source files change?▼

You can generate self-contained canonical documentation by running `/canonical-reproducer render-domain --domain <domain_name>`, which extracts DDL, pseudo-code, and SDL into stable outputs without file or line references.

What is canonical form documentation in software domain engineering?▼

Canonical form documentation transforms verified code knowledge into standalone DDL, pseudo-code, and SDL documents that survive code refactoring by removing direct file and line references from the extracted domain overview, schema, and API outputs.

Does canonical-reproducer work with Factum schema evolution history and GraphQL datasets?▼

Yes, canonical-reproducer integrates with Factum to utilize schema evolution history and GraphQL type datasets for generating stable domain documentation, leveraging these inputs for self-contained DDL, pseudo-code, and SDL outputs.

How can I compare generated canonical documents against original source artifacts?▼

Canonical-reproducer offers a dedicated compare mode to render and validate generated canonical documents against original source artifacts, verifying that the standalone DDL, pseudo-code, and SDL outputs accurately reflect the verified codebase knowledge.

What software documentation outputs are included in canonical domain rendering?▼

Canonical domain rendering produces domain-specific outputs including domain overviews, schemas, APIs, pseudo-code, scenarios, glossaries, invariants, and use-cases, all formatted as self-contained documents without code version dependencies.

When should I avoid generating documentation tied to specific code line numbers?▼

You should avoid file and line references when documentation must remain stable through code refactoring, as canonical form generation extracts DDL, pseudo-code, and SDL into self-contained documents to survive source modifications.

Related Skills

Explore More Software Engineering Skills→
SempriniSemprini
1

lifecycle

Promote data domains through lifecycle stages and bump semantic versions for MD-DDL definitions.

Community
Advanced
SempriniSemprini
1

schema-import

Convert database schemas and ETL logic into draft MD-DDL domain models.

Community
Advanced
MicrockMicrock
322

PDF Processing

Extract text and tables from PDF files with pdfplumber.

Community
Advanced
quranquran
1.9k

generate-verified-docs

Generate audit-grade documentation with code references from codebase features.

Official
Advanced