documentation-standards

Standardize platform documentation with frontmatter-driven structure, templates, and style guidelines.

3|Updated Mar 5, 2026

Search Tags:#templates #documentation #adr #readme #standards #api-docs #style-guides

Ready to run

npx skills add https://github.com/bipinks/ghost-office --skill documentation-standards-bipinks

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-standards
Source: https://github.com/bipinks/ghost-office/tree/main/.claude/skills/documentation-standards
Command: npx skills add https://github.com/bipinks/ghost-office --skill documentation-standards-bipinks

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Inconsistent and hard-to-maintain platform documentation across API docs, ADRs, user guides, and knowledge bases slows onboarding and increases confusion; this Skill provides a standardized approach to structure, templates, and styles that unify documentation output.

Core Features & Use Cases

Templates and patterns for API docs, ADRs, changelogs, READMEs, and user guides to enforce consistency.
Style guides and knowledge base maintenance guidelines to keep documentation up-to-date and discoverable.
Use Case: A team publishes a new API endpoint with complete docs, ADR, and changelog following the standard patterns.

Quick Start

Begin by applying the documented templates and style rules to your API docs, ADRs, and READMEs.

Frequently Asked Questions about documentation-standards

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

FAQPage Schema

How do I create consistent API documentation and READMEs across multiple teams?▼

To create consistent API documentation and READMEs across teams, you need standardized templates, style guidelines, and frontmatter-driven structures to unify output and ensure maintainability.

What is the best way to structure Architecture Decision Records (ADRs) for platform maintainability?▼

The best way to structure ADRs for platform maintainability is applying standardized templates and style guidelines that enforce consistency and discoverability across your knowledge base.

How do I standardize changelogs and knowledge bases to improve onboarding?▼

Standardize changelogs and knowledge bases by defining frontmatter-driven structures, maintenance guidelines, and documentation workflows to keep content up-to-date and reduce onboarding confusion.

Can I use frontmatter-driven documentation templates for user guides and API docs?▼

Yes, you can use frontmatter-driven documentation templates to enforce a unified structure across API docs, user guides, READMEs, and ADRs for better content discoverability.

What are the limitations of using standardized documentation templates without style guidelines?▼

Using standardized templates without style guidelines risks inconsistent formatting and hard-to-maintain documentation, which slows onboarding and increases platform confusion across teams.