Research frontmatter
Skill joaquimscosta/arkhe-claude-plugins/plugins/doc/skills/research-frontmatter
Supercharge Claude Code with 109 specialized components — 22 agents, 32 commands, 55 skills across 13 modular plugins. Deep reasoning, autonomous dev loops, DDD architecture, design system enforcement, git automation, and more.
npx -y skills add joaquimscosta/arkhe-claude-plugins --skill research-frontmatterAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- 21 stars21 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its author says it does
Copied from the file, not written here
Validate and enforce standard YAML frontmatter on research documents with JD-aware path resolution. Use when creating, editing, or validating research files, when user mentions "research metadata", "research frontmatter", "research staleness", "validate research", "RD-rules", or "research docs validation".
SKILL.md
3.3 KB, 735 tokens by cl100k_base, as published. Nobody here has run it
Research Frontmatter
Enforce standard YAML frontmatter on research documents so GitHub renders metadata as a table and readers can judge staleness.
Quick Start
# Validate all research documents
uv run ${CLAUDE_SKILL_DIR}/scripts/validate_research_docs.py --format text
# Check staleness only
uv run ${CLAUDE_SKILL_DIR}/scripts/validate_research_docs.py --staleness-only
# Resolve research path (JD-aware)
uv run ${CLAUDE_SKILL_DIR}/scripts/resolve_research_path.py --format json
# Override research directory
uv run ${CLAUDE_SKILL_DIR}/scripts/validate_research_docs.py --research-dir docs/30-research
Required Frontmatter
Every research file MUST have these 5 fields:
---
title: "Human-readable title"
version: "1.0.0"
status: Published # Published | Draft | Living Document
created: YYYY-MM-DD
last_updated: YYYY-MM-DD
---
Optional fields (slug, tags, aliases, promoted_at, last_refreshed, sources) MAY follow.
JD-Aware Path Resolution
The skill auto-detects Johnny.Decimal structure:
- Look for
.jd-config.jsonat project root - Find area containing "research" (default: prefix
30) - Construct path:
{root}/{prefix}-{name}/(e.g.docs/30-research/) - Fall back to
docs/research/if no JD config
This applies to both validation and the deep-research promote workflow.
Validation Rules
| Rule | Severity | Check |
|---|---|---|
| RD001 | ERROR | Missing YAML frontmatter |
| RD002-006 | ERROR | Missing required field (title, version, status, created, last_updated) |
| RD007 | ERROR | Invalid status value |
| RD008-009 | WARNING | Invalid date format |
| RD010 | WARNING | Invalid version format |
| RD011 | WARNING | Missing Executive Summary section |
| RD012 | WARNING | Missing References section |
| RD013 | ERROR | Research doc not in README.md index |
| RD014 | WARNING | README index metadata mismatch |
| RD015 | WARNING | Index references missing file |
| RD016 | WARNING | Stale last_updated vs git history |
Version Increment
- Patch (1.0.0 -> 1.0.1): Typo fixes, formatting, minor clarifications
- Minor (1.0.0 -> 1.1.0): New sections, updated examples
- Major (1.0.0 -> 2.0.0): Complete rewrite, fundamental scope change
README Index Format
The research README.md MUST use these columns:
| Topic | Version | Status | Created | Last Updated |
Integration
- deep-research: Promote uses JD-aware path resolution for Tier 2 output
- doc-freshness: Research docs with
last_updatedqualify for deep scanning - jd-docs: Area
30-researchis the default research home in JD structure
Template
New research files should follow the TEMPLATE.md in the research directory.
See WORKFLOW.md for detailed procedures. See EXAMPLES.md for usage examples. See TROUBLESHOOTING.md for common issues.