Skip to content

mif-docs genre and CLI catalog

An exhaustive lookup for the mif-docs v0.2.0 plugin: every skill it ships, every doc-set recipe, and every script in scripts/ with its arguments and exit behavior. Consult an entry; do not read this end to end.

Each genre ships good-l1.md (L1 floor), good.md (target level), bad.md, and evals/evals.json.

SkillArtifact it authorsMIF conceptTypeTarget level
diataxis-tutorialLearning-oriented hands-on lessonprocedural2
diataxis-how-toTask-oriented recipeprocedural2
diataxis-referenceInformation-oriented lookup of one thingsemantic3
diataxis-explanationUnderstanding-oriented discussionsemantic3
arc42-arch-docarc42 12-section architecture documentsemantic3
c4-model-diagramC4 model document (Context/Container/Component/Code)semantic3
google-design-docGoogle-style engineering design docsemantic3
engineeringEngineering decision / evaluation report (options-vs-criteria comparison table)semantic3
adrArchitectural Decision Record (Structured MADR)semantic3
rust-rfcRust-style RFC / enhancement proposalsemantic3
python-pepPython Enhancement Proposalsemantic3
changelogKeep a Changelog 1.x version historysemantic2
sre-runbookTactical step-by-step incident runbookprocedural2
playbookStrategic multi-incident operations playbookprocedural3
prdProduct Requirements Documentsemantic3
feature-specLightweight AI-ready feature specificationsemantic2
ai-architecture-docComposite AI-spec architecture documentsemantic3
kiro-requirementsKiro requirements.md (user stories + EARS)semantic3
kiro-designKiro design.md (technical design)semantic3
kiro-tasksKiro tasks.md (checkbox implementation plan)procedural2
academicPeer-review-style IMRaD scholarly papersemantic3
systematic-reviewPRISMA systematic review / meta-analysissemantic3
computing-paperACM/IEEE computing paper (IEEE numbered citations)semantic3
humanities-mlaMLA-style humanities papersemantic3
humanities-chicagoChicago-style humanities paper (notes-bibliography)semantic3
clinical-submissionClinical study report (ICH E3 CSR / CTD module frame)semantic3
nist-spNIST Special Publication structuresemantic3
regulatory-disclosureSEC-style annual disclosure (Reg S-K / Form 10-K item order)semantic3
compliance-auditCompliance audit report (SOC 2-style controls + findings)semantic3
security-pentestPenetration-test report (PTES/OWASP-style, CVSS findings)semantic3
legal-memoPredictive legal memorandum (IRAC, Bluebook citations)semantic3
market-research-reportMarket research report (methodology/fieldwork-grounded)semantic3
sustainability-reportGRI-Standards sustainability/ESG reportsemantic3
trend-analysisTrajectory report (drivers/inhibitors, scenario diagram)semantic3
competitive-quadrantTwo-axis competitive-quadrant report (Mermaid quadrant chart)semantic3
briefingOne-page briefing / standup updateepisodic3
exec-summary1-2 page BLUF decision-oriented executive summarysemantic3

These do not author a finished genre artifact; they supply or check the MIF layer that every genre rides on, plus the multi-document engine.

SkillRole
mif-frontmatterAuthor MIF Level 1–3 frontmatter for any document, climbing L1→L3 as detail allows.
ears-acceptance-criteriaTurn a requirement or driver into an EARS-notation acceptance criterion.
mif-validateDeterministically prove a document is MIF-conformant and convert between forms.
doc-set-plannerPlan a subject into a coordinated SET of documents, fan out to genres, reconcile the relationship graph.

doc-set-planner decomposes a broad subject using one of four recipes. Each recipe names its member genres and the cross-document relationship graph that planner-check verifies for link-completeness.

RecipeDecomposes into
diataxistutorial + how-to + reference + explanation
ai-specAI-ready specification set (feature-spec + ai-architecture-doc + EARS criteria)
kiroKiro three-document set: requirements + design + tasks
architectureArchitecture set: arc42 + C4 + ADRs

All scripts run on Node.js 20+ and are invoked as node scripts/<name>.mjs. Every script is fail-closed: any failure exits non-zero.

ScriptInvocationExit behavior
mif-validate.mjsmif-validate <file> [--level 1|2|3] [--no-roundtrip]0 valid; 1 schema/level/round-trip failure; 2 usage error (no file).
mif-convert.mjsmif-convert <emit-jsonld|emit-markdown|roundtrip> <file> [--no-check]0 success; 1 schema check / non-lossless round-trip; 2 usage error.
hydrate-schema.mjshydrate-schema [latest|<version>]0 schema cached + VENDOR.lock written; 1 fetch failure (reports last hydrated version).
hydrate-ontology.mjshydrate-ontology0 ontology cached from published URI / ontologies repo / local sibling checkout; 1 unresolved.
validate-ontology.mjsvalidate-ontology0 ontology valid and all entity_type / relationship types resolve; 1 not hydrated or dangling reference.
validate-plugin.mjsvalidate-plugin0 plugin.json, marketplace.json, and every SKILL.md frontmatter valid; 1 any structural violation.
check-exemplars.mjscheck-exemplars0 every genre’s good-l1.md validates at L1 and good.md at its target level; 1 otherwise.
planner-check.mjsplanner-check [<recipe>]0 recipe(s) decompose to real member skills and the cross-link graph is complete; 1 otherwise.
  • mif-validate --level defaults to 1. The level overlay layers required fields on top of the canonical schema: L2 requires namespace, modified, temporal; L3 additionally requires provenance and temporal.validFrom.
  • mif-convert emit-markdown schema-checks the JSON-LD input before projecting, unless --no-check is given. roundtrip reports whether md↔JSON-LD is lossless.
  • hydrate-schema resolves latest by default and records the resolved version in schema/VENDOR.lock; offline, mif-validate falls back to the last hydrated copy and warns.
  • planner-check with no argument checks every recipe under skills/doc-set-planner/recipes/.

The skills by purpose reference gives each skill its own detailed write-up, grouped by the job it does; this catalog is the terse lookup for genres, recipes, and scripts. The getting-started tutorial walks through installing and validating a first document; the how-to gives the validate/author/convert recipe; the explanation covers why each document is both a human artifact and a machine unit. All three are linked from this reference’s relationships[], which keeps rationale out of the catalog per Diátaxis.