docs-contract-authoring

Author documentation artifacts that validate against docs/contracts schemas with exact frontmatter.

Updated Jul 8, 2026
One-click install
npx skills add https://github.com/NarenKarthikBM/specseyal --skill docs-contract-authoring-narenkarthikbm
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-contract-authoring
Source: https://github.com/NarenKarthikBM/specseyal/tree/main/.claude/skills/docs-contract-authoring
Command: npx skills add https://github.com/NarenKarthikBM/specseyal --skill docs-contract-authoring-narenkarthikbm

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing contract-bound documentation by hand leads to drift: sections go missing, enum values get misspelled, and coverage claims go unverified. This Skill ensures every documentation artifact — a docs/contracts/ schema, a frontmatter-bearing record, or a template rendering into one — validates against its contract before being called done. ## Core Features & Use Cases - Contract-derived structure: Authors every required section in the contract's exact order and spelling, deriving structure from the contract itself rather than a drift-prone parallel copy. - Exact machine-readable frontmatter: Places status, phase, and enum fields in YAML frontmatter with character-for-character fidelity to the contract's enumerated values. - Mechanical coverage checks: Adds grep-based assertions that verify every item of a source set appears in the document, and flags genuine gaps explicitly instead of fabricating coverage. - Use Case: When writing a completion report or findings document governed by a docs/contracts/ schema, use this Skill to produce an artifact whose normative core validates cleanly, with appendices fenced outside the validated core. ## Quick Start Author a completion report that validates against its docs/contracts schema, with exact frontmatter enums and a mechanical coverage check for every required item.

Frequently Asked Questions about docs-contract-authoring

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

FAQPage Schema
How do I author a document that validates against a contract schema?

Derive the document's section list directly from the contract itself, keeping every required section in the contract's order and exact spelling. Validate the artifact against the contract before considering it complete.

How do I write YAML frontmatter for contract-validated records?

Place every machine-readable field — status, phase, enum values — in YAML frontmatter, spelling each closed-enum value character-for-character as the contract enumerates it. Prose-only content stays in the body.

How do I prove a document covers every required item?

Add a mechanical check that greps the source of truth and asserts each item appears in the document. The completeness claim is enforced by the check rather than by careful manual reading.

What should I do when source material doesn't cover a required section?

Flag it as an explicit gap in the document. Never fabricate a covered row to make the coverage number look whole — an honest gap is the correct state.

Can a contract-validated document include extra appendix material?

Yes, but keep the normative core and appendix cleanly separated. The contract validates the core, so extra material rides outside it, clearly fenced, and the core must still validate with the appendix absent.