requirement-parser

Parse YAML frontmatter from Markdown requirement files and validate required fields.

5|2|Updated Jan 22, 2026
One-click install
npx skills add https://github.com/hyperbolic-c/auto-writing --skill requirement-parser
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: requirement-parser
Source: https://github.com/hyperbolic-c/auto-writing/tree/main/auto-academic-writing/skills/requirement-parser
Command: npx skills add https://github.com/hyperbolic-c/auto-writing --skill requirement-parser

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps users transform unstructured requirement notes into a structured data model by parsing and validating YAML frontmatter in academic writing requirement files, reducing manual checks and errors.

Core Features & Use Cases

  • Parse YAML frontmatter from Markdown requirement files.
  • Validate required fields (title, topic, length, style, references) and report missing or incorrect types.
  • Output a structured data object (e.g., JSON) for downstream writing tools and workflows.
  • Use Case: Given a requirements.md with title, topic, length, and references, automatically extract and standardize the data for outline generation.

Quick Start

Run the parser on a file named requirements.md to extract and validate its frontmatter.

Frequently Asked Questions about requirement-parser

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

FAQPage Schema
How do I validate YAML frontmatter in Markdown files for academic writing?

You can validate YAML frontmatter by parsing the Markdown file and checking for required academic fields like title, topic, length, style, and references. The parser enforces field presence and type correctness, reporting any missing or invalid entries to ensure your requirements are standardized before downstream writing tasks.

What is YAML frontmatter parsing and why is it needed for academic requirement files?

YAML frontmatter parsing extracts structured metadata from the top of Markdown files. It is needed for academic requirement files to transform unstructured notes into a standardized data model, reducing manual checks and errors while preparing inputs for outline generation and other writing workflows.

How do I extract structured data from Markdown frontmatter for downstream writing tasks?

You extract structured data by parsing the YAML frontmatter and validating its fields to produce a machine-readable JSON object. This structured output standardizes requirements like topic and length, allowing downstream writing tools to seamlessly consume the data for tasks such as outline generation.

Can I check for missing or invalid fields in academic writing Markdown automatically?

Yes, you can automatically check for missing or invalid fields by running a validation parser on your Markdown file. It enforces type correctness and field presence for specified academic requirements, returning a machine-readable summary that details exactly what needs to be corrected.

What happens if required fields are missing from my Markdown frontmatter?

If required fields are missing from your Markdown frontmatter, the parser will identify the omissions and report them as errors. It enforces field presence and type correctness, ensuring you are notified of missing or invalid data before the file is used in downstream academic writing workflows.