documentation

Standardize when to create or update project documentation with frontmatter and cross-referencing rules.

4|11|Updated May 1, 2025

Search Tags:#templates #documentation #governance #standards #decision-making #cross-referencing #evergreen

Ready to run

npx skills add https://github.com/Rational-Partners/ai-training-practical --skill documentation-rational-partners

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/Rational-Partners/ai-training-practical/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/Rational-Partners/ai-training-practical --skill documentation-rational-partners

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation decisions are inconsistent and siloed, making it hard to know when to document, how to structure content, and how to maintain existing docs.

Core Features & Use Cases

Establish when to document and when to skip documentation using clear criteria.
Provide a standardized structure for evergreen and planning content, including cross-referencing rules.
Guide teams through planning, implementation, and maintenance of documentation across features.

Quick Start

Assess a new feature or change against the decision criteria and apply the standard structure to create or update docs.

Frequently Asked Questions about documentation

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

FAQPage Schema

How do I establish consistent documentation standards across feature work and API changes?▼

Documentation standards are established by applying consistent criteria for when to create or update content, specifying frontmatter requirements, type classifications, and cross-referencing rules across features, API changes, and architectural shifts.

When should I create or update project documentation for complex workflows?▼

Project documentation should be created or updated by assessing a feature or change against clear decision criteria, ensuring evergreen content and cross-references are maintained during planning, implementation, and maintenance phases.

What is the best way to structure evergreen content and cross-referencing rules for architectural shifts?▼

Structuring evergreen content involves applying a standardized layout that defines frontmatter fields, type classifications, and cross-referencing rules to ensure consistent references across architectural shifts and complex workflows.

How do I standardize frontmatter fields and type classifications for project documentation?▼

Frontmatter fields and type classifications are standardized by specifying exact requirements and structures for content, ensuring consistent references and governance across all feature work and planning documentation.

Does this documentation governance approach work for planning, implementation, and maintenance phases?▼

Documentation governance applies across planning, implementation, and maintenance phases by guiding teams through standardized structures and decision criteria, ensuring consistent references throughout the entire project lifecycle.

Why does inconsistent and siloed documentation make it hard to maintain existing docs?▼

Inconsistent and siloed documentation makes maintenance difficult because without standardized criteria for when to document and how to structure content, cross-referencing rules break down and references become outdated.