skills.rest
BrunoAMSilva
BrunoAMSilvaCOMMUNITY
Explore all skills by this author →
GitHub

update-specification

Update Markdown specification files with YAML frontmatter for AI consumption.

Updated Apr 14, 2026
Search Tags:#documentation#markdown#specification#requirements#validation#ai-ready#interface
One-click install
npx skills add https://github.com/BrunoAMSilva/my-config --skill update-specification-brunoamsilva
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-specification
Source: https://github.com/BrunoAMSilva/my-config/tree/main/coding/skills/update-specification
Command: npx skills add https://github.com/BrunoAMSilva/my-config --skill update-specification-brunoamsilva

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Updating specification documents after code or requirement changes is often inconsistent, ambiguous, and not structured for automated consumption, which makes it hard for generative AIs and automation pipelines to reliably interpret and act on them.

Core Features & Use Cases

  • Template-driven Updates: Provides a clear, machine-readable Markdown template with required YAML frontmatter to ensure consistency across specifications.
  • AI-Optimized Structure: Separates requirements, constraints, interfaces, acceptance criteria, tests, and examples to make documents parsable and actionable by LLMs.
  • Use Case: Convert an outdated architecture or API spec into a validated, AI-friendly document that includes explicit data contracts, acceptance criteria, and test automation guidance.

Quick Start

Update the specification file in the project's spec directory to include the required YAML frontmatter, clearly list requirements and interfaces, and verify the document follows the provided template for AI consumption.

Frequently Asked Questions about update-specification

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

FAQPage Schema
How do I update a markdown specification to make it AI-ready?▼

To update a markdown specification to be AI-ready, apply a template-driven structure with required YAML frontmatter. This separates requirements, constraints, and interfaces to create a machine-readable document optimized for automated parsing and generative AI consumption.

What is an AI-ready specification file?▼

An AI-ready specification file is a well-formed Markdown document with YAML frontmatter that explicitly defines requirements, acceptance criteria, and test strategies. This structured format ensures generative AIs and automation pipelines can reliably interpret and act on the data contracts.

When do I need to update specification files for automated parsing?▼

You need to update specification files for automated parsing when requirements, code, or architecture change across schemas, tools, data, infrastructure, process, architecture, or design. This ensures the project's spec directory remains consistent and validated.

What is the best way to structure requirements and interfaces for LLMs?▼

The best way to structure requirements and interfaces for LLMs is to separate them into distinct sections within a Markdown template. Clearly list data contracts, constraints, acceptance criteria, and validation criteria to make the document parsable and actionable.

Does this specification update process require specific dependencies?▼

No, updating specification files using this template-driven process requires no specific dependencies. You only need to apply the provided Markdown template with YAML frontmatter to your project's spec directory to ensure machine-readable consistency.

Related Skills

Explore More Software Engineering Skills→
refactory-langrefactory-lang

speckit-baseline

Generate baseline project documentation by executing a script to capture project state.

Official
Intermediate
ilandahanilandahan
9

aid-qa-ship

Validate implementations against acceptance criteria and certify software releases.

Community
Basic
rikdcrikdc
2

specify

Converts design documents into technical specifications with data models and API contracts.

Community
Basic
GabeujinGabeujin

create-specification

Generate machine-readable Markdown specification files for Generative AI consumption.

Community
Intermediate