structured-docs-migration

Convert legacy prose documentation into canonical structured YAML artifacts.

80|2|Updated May 14, 2026
One-click install
npx skills add https://github.com/PriNova/pi-agent-codebase-workflows --skill structured-docs-migration
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: structured-docs-migration
Source: https://github.com/PriNova/pi-agent-codebase-workflows/tree/main/skills/structured-docs-migration
Command: npx skills add https://github.com/PriNova/pi-agent-codebase-workflows --skill structured-docs-migration

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Legacy prose-style documentation is brittle, hard to version, and incompatible with automated workflows. This skill migrates those artifacts into canonical structured YAML for agent-first ingestion, enabling reliable, schema-driven processing and elimination of deprecated Markdown generation in the final artifact set.

Core Features & Use Cases

  • Converts legacy prose docs under docs/agent/api and related mappings into stable, structured YAML artifacts using the resolved structured docs root.
  • Enforces the artifact write/update protocol: stable IDs, evidence, cross-links, and envelope conformance to shared schemas.
  • Supports end-to-end migration including mapping legacy inputs (AGENTS.md, REPO_INVENTORY.md, PROJECT_INTENT.md, ARCHITECTURE.md, DATA_FLOW.md, DATA_MODEL.md, INVARIANTS.md, DEPENDENCY_RULES.md, DESIGN_ISSUES.md, RISK_REGISTER.md, CHANGE_GUIDE.md, TESTING_STRATEGY.md, VALIDATION_BASELINE.md, CONTRACTS.md, adr/*.md, SCOPES.md) to structured artifacts and validating references.

Quick Start

Map legacy prose docs to canonical YAML artifacts under the resolved structured docs root using the migration workflow.

Frequently Asked Questions about structured-docs-migration

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

FAQPage Schema
How do I convert legacy Markdown documentation into structured YAML artifacts?▼

To convert legacy Markdown documentation into structured YAML artifacts, you map prose-style inputs like ARCHITECTURE.md and DATA_FLOW.md to canonical structured counterparts. This process enforces stable IDs, cross-links, and schema validation for agent-first ingestion.

Why does structured documentation migration eliminate deprecated Markdown generation?▼

Structured documentation migration eliminates deprecated Markdown generation by converting brittle prose into canonical structured YAML. This schema-driven approach ensures reliable, automated processing and replaces inconsistent Markdown files with stable artifacts.

What is the best way to validate schema references during a YAML documentation migration?▼

Validating schema references during a YAML documentation migration is handled by enforcing envelope conformance to shared artifact schemas. The migration workflow validates cross-links and evidence during upsert and compaction operations to ensure reference integrity.

Can I migrate repository-level ADRs and scoped docs into structured YAML?▼

You can migrate repository-level ADRs and scoped docs into structured YAML by applying the migration workflow to inputs like adr/*.md and SCOPES.md. It maps these legacy files to their artifact counterparts under the resolved structured docs root.

Does the structured documentation migration workflow support upsert and compaction for YAML artifacts?▼

The structured documentation migration workflow supports upsert and compaction for YAML artifacts. It applies the artifact write/update protocol to ensure stable IDs, cross-links, and evidence conform to shared schemas during these operations.