document-spec-policy

Enforces authoring rules for specification documents under .github/docs.

2|1|Updated May 11, 2019
One-click install
npx skills add https://github.com/guitarrapc/dotfiles-win --skill document-spec-policy-guitarrapc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-spec-policy
Source: https://github.com/guitarrapc/dotfiles-win/tree/main/HOME/.agents/skills/document-spec-policy
Command: npx skills add https://github.com/guitarrapc/dotfiles-win --skill document-spec-policy-guitarrapc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams often let specification documents drift out of sync with actual implementations, or fill specs with low-level implementation details that belong in code. This Skill defines a clear policy for what belongs in spec files under .github/docs/ so documentation stays accurate and useful. ## Core Features & Use Cases - Content Boundaries: Defines that specs contain WHAT, WHY, and lessons learned, while detailed HOW (step-by-step implementation, code structure, algorithm internals) belongs in code comments or implementation files. - Post-Implementation Updates: Requires updating related spec files after implementation to reflect what was actually built, including decisions and lessons discovered during development. - Cross-Document Consistency: Enforces consistency rules between parser specs and downstream documents. - Use Case: After shipping a new parser feature, use this Skill to review and update the related spec files so they document the actual behavior and any unexpected constraints discovered during implementation. ## Quick Start Review the spec files under .github/docs for the feature I just implemented and update them according to the specification document policy.

Frequently Asked Questions about document-spec-policy

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

FAQPage Schema
What should a specification document contain?

A specification document should contain WHAT the feature or behavior is, WHY the decision was made, and lessons learned from actual implementation. It should not contain detailed HOW such as step-by-step instructions, code structure, or algorithm internals.

Where do implementation details belong if not in specs?

Detailed implementation instructions belong in code comments, skill directories like .claude/skills/, or the implementation itself. Specs under .github/docs are reserved for behavior, motivation, and lessons learned.

When should I update spec files after implementing a feature?

Update related spec files immediately after implementation. Document what was actually built, including decisions made during development and lessons learned that were not captured upfront, so specs reflect reality.

How do I keep parser specs consistent with downstream documents?

Follow the cross-document consistency rules in the policy: when a parser spec changes, review and update all downstream documents that depend on it. Refer to .github/docs/docs_authoring_guidelines.md for the full authoring reference.

What are lessons learned in a specification document?

Lessons learned are insights discovered only by actually building the feature, such as unexpected constraints, failed approaches, or surprising behavior. Recording them in specs preserves knowledge that would otherwise be lost.