doc-standards

Standardize Citum spec and policy creation with templates and validation.

31|Updated Jan 28, 2026

Search Tags:#architecture #templates #documentation #specification #pre-commit #policy

Ready to run

npx skills add https://github.com/citum/citum-core --skill doc-standards-citum

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-standards
Source: https://github.com/citum/citum-core/tree/main/.claude/skills/doc-standards
Command: npx skills add https://github.com/citum/citum-core --skill doc-standards-citum

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It standardizes how Citum specs, policies, and architecture/guides are written so decisions are traceable, reviewable, and easy for agents to apply consistently.

Core Features & Use Cases

Directory selection guidance: routes each document type to the correct docs folder (specs, policies, architecture, guides, references).
Turnkey spec and policy templates: provides ready-to-fill structures with normative sections like Purpose/Scope/Design and a self-contained Rule for policies.
Pre-commit validation checklist: helps ensure metadata (status/version/date/related) and acceptance criteria are present, and reduces broken links and missing approvals.

Quick Start

Create docs/specs/FEATURE_NAME.md using the Spec Template, include an Acceptance Criteria checklist item, and set the Status to Draft until the feature is ready for implementation.

Frequently Asked Questions about doc-standards

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

FAQPage Schema

How do I standardize feature specification templates for consistent documentation?▼

Standardize feature specifications by applying prescribed templates with normative Purpose, Scope, and Design sections, ensuring traceable and reviewable decisions across your docs/specs directory.

What is the correct directory structure for organizing architecture snapshots and policy documents?▼

Organize architecture snapshots and policies by routing each document type to its correct docs folder—specs, policies, architecture, guides, or references—based on directory mapping guidance.

How do I validate documentation frontmatter metadata before committing?▼

Validate frontmatter metadata before committing by running a pre-commit validation checklist to confirm status, version, date, related links, and acceptance criteria are complete and functional.

What sections are required when writing an active behavioral policy document?▼

Writing an active behavioral policy requires using a turnkey template with a self-contained Rule section, ensuring the policy is easy for agents to apply consistently and review.

Can I use these documentation standards for operational how-to guides and reference lookup tables?▼

Yes, these documentation standards apply to writing operational how-to guides and reference lookup tables, ensuring consistent creation, placement, and validation across the entire docs tree.