Research Frontmatter
Documentsresearch-frontmatterResearch Frontmatter is an Agent Skill for documents published in the majiayu000/claude-skill-registry repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Enforce standard YAML frontmatter on research documents in docs/research/. Use when creating, editing, or promoting research files, when user mentions "research metadata", "research frontmatter", or "research staleness".
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/majiayu000/claude-skill-registry/blob/HEAD/skills/documents/research-frontmatter/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/research-frontmatter, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Research Frontmatter Standard
Ensure all research files in docs/research/ have standard YAML frontmatter so GitHub renders metadata as a table and readers can judge staleness.
Required Frontmatter
Every research file MUST have these 5 fields at the top of the YAML block:
---
title: "Human-readable title"
version: "1.0.0"
status: Published # Published | Draft | Living Document
created: YYYY-MM-DD
last_updated: YYYY-MM-DD
---
Additional fields (slug, tags, aliases, promoted_at, last_refreshed, sources) MAY follow the standard fields.
Field Definitions
| Field | Required | Format | Description |
|---|---|---|---|
title | Yes | Quoted string | Human-readable document title |
version | Yes | Semver string | Content maturity version |
status | Yes | Enum | Published, Draft, or Living Document |
created | Yes | YYYY-MM-DD | Date first authored (from git or inline) |
last_updated | Yes | YYYY-MM-DD | Date of last substantive content change |
When to Increment Version
- Patch (1.0.0 -> 1.0.1): Typo fixes, formatting, minor clarifications
- Minor (1.0.0 -> 1.1.0): New sections added, examples updated
- Major (1.0.0 -> 2.0.0): Complete rewrite, fundamental scope change
README Index
The docs/research/README.md table MUST use these columns:
| Topic | Version | Status | Created | Last Updated |
When adding a new entry, append a row matching this format.
Template
New research files should follow docs/research/TEMPLATE.md.
Validation Checklist
When triggered, verify:
- File has YAML frontmatter (starts with
---) - All 5 required fields are present
statusis one of the 3 allowed values- Dates use ISO 8601 format (
YYYY-MM-DD) - Standard fields appear before any extra fields
- README.md entry exists and columns match