openspec-authoring

Enforce OpenSpec authoring conventions for proposals, tasks, and spec files.

2|Updated Nov 13, 2025
One-click install
npx skills add https://github.com/ricardoroche/ricardos-claude-code --skill openspec-authoring
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: openspec-authoring
Source: https://github.com/ricardoroche/ricardos-claude-code/tree/main/.claude/skills/openspec-authoring
Command: npx skills add https://github.com/ricardoroche/ricardos-claude-code --skill openspec-authoring

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill standardizes the creation and revision of OpenSpec documents, ensuring consistency, clarity, and adherence to established conventions. It eliminates ambiguity in proposals, tasks, and specification deltas, making documentation easier to read, review, and maintain.

Core Features & Use Cases

  • Metadata & Frontmatter: Enforces inclusion of Change ID, Status, Date, and Author for proposals and tasks, and specific headers for specs.
  • Required Section Ordering: Guides on the correct sequence of sections for proposal.md, tasks.md, and spec.md (delta).
  • Requirement & Scenario Patterns: Defines how to structure requirements with Given/When/Then scenarios, ensuring testability and behavior-focused descriptions.
  • Validation Checklist: Provides a checklist for self-validation, including checking referenced skills/agents and workspace-relative paths.
  • Use Case: A product manager is drafting a new feature proposal. This skill guides them through structuring the proposal.md with an executive summary, goals, approach, and risks, ensuring all necessary information is present and well-organized for stakeholders.

Quick Start

Help me structure a new OpenSpec proposal for a feature, ensuring all required sections are present and in the correct order.

Frequently Asked Questions about openspec-authoring

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

FAQPage Schema
How do I write a clear, consistent technical specification that follows documentation standards?

OpenSpec authoring enforces metadata blocks, section ordering, and requirement structures to standardize specification documents. It ensures proposals, tasks, and spec files include required frontmatter like Change ID, Status, Date, and Author, then guides you through correct section sequencing and Given/When/Then scenario patterns for testable, behavior-focused requirements.

What's the correct structure for organizing sections in a proposal or spec document?

OpenSpec defines required section ordering for proposal.md, tasks.md, and spec.md files. It specifies which metadata and frontmatter must come first, followed by content sections in a standardized sequence, ensuring stakeholders encounter information in a predictable, logical flow.

How do I write requirements and scenarios that are testable and clear?

OpenSpec guides structuring requirements with Given/When/Then scenario patterns, which define preconditions, actions, and expected outcomes. This approach ensures requirements are behavior-focused, unambiguous, and directly testable rather than vague descriptive statements.

Can I validate my technical documentation against authoring conventions?

OpenSpec provides a validation checklist that lets you self-check whether your document includes required metadata, correct section ordering, proper requirement patterns, referenced skills and agents, and workspace-relative paths—catching gaps before review.

What metadata and frontmatter do I need to include in proposals and tasks?

OpenSpec requires Change ID, Status, Date, and Author fields in proposal and task frontmatter, plus specific headers for spec files. This metadata standardizes tracking, versioning, and accountability across all specification documents.

Why should I follow a consistent specification format across my documentation?

Standardized OpenSpec conventions eliminate ambiguity, reduce review friction, and make documentation easier to maintain. Consistent metadata, section ordering, and requirement patterns ensure stakeholders and reviewers know where to find information and how to interpret requirements.