skills.rest
KingInYellows
KingInYellowsOFFICIAL
Explore all skills by this author →
GitHub

docs-conventions

Enforce standardized documentation templates and Mermaid diagram conventions across repositories.

Updated Jan 10, 2026
Search Tags:#architecture#templates#documentation#consistency#mermaid#audit#staleness
One-click install
npx skills add https://github.com/KingInYellows/yellow-plugins --skill docs-conventions-kinginyellows
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-conventions
Source: https://github.com/KingInYellows/yellow-plugins/tree/main/plugins/yellow-docs/skills/docs-conventions
Command: npx skills add https://github.com/KingInYellows/yellow-plugins --skill docs-conventions-kinginyellows

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides standardized patterns for documenting projects, ensuring consistent structure, templates, and diagrams across teams.

Core Features & Use Cases

  • Standardized README templates for project introductions, usage, and contribution guidelines.
  • Architecture and API diagram conventions using Mermaid-friendly formats.
  • Staleness detection and audit guidance to keep documentation up-to-date across codebases.

Quick Start

Ask your AI assistant to generate a project documentation scaffold following the shared conventions for the target repository.

Frequently Asked Questions about docs-conventions

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

FAQPage Schema
How do I create consistent documentation templates across multiple repositories?▼

You create consistent documentation by applying standardized README, architecture, and API reference templates across projects. This enforces uniform structure, contribution guidelines, and diagram conventions for all your repositories.

What is the best way to standardize architecture diagrams using Mermaid?▼

Standardizing Mermaid diagrams involves applying shared formatting conventions for architecture and API visuals. This ensures all project documentation uses consistent, readable, and Mermaid-friendly diagram formats.

How do I detect staleness in project documentation?▼

Detecting documentation staleness requires running audit checks against your codebase. This strategy identifies outdated README files and module docs, keeping your structured documentation up-to-date.

Can I use these documentation conventions for any repository needing API references?▼

Yes, these conventions apply to any repository needing API references and module documentation. They provide scalable templates and staleness-detection strategies suitable for diverse codebases.

What is included in a standardized README template for project introductions?▼

A standardized README template includes sections for project introductions, usage instructions, and contribution guidelines. This ensures all team members follow the same structural patterns for onboarding and development.

Related Skills

Explore More Content & Communication Skills→
az9713az9713

dark-code-suite-init

Initialize a project with dark code prevention directories, CLAUDE.md section, and baseline audit.

Community
Intermediate
jokken79jokken79
1

documentation-generator

Generate API references, READMEs, user guides, and architecture diagrams from codebases.

Community
Advanced
adryanmoldokkr32-pixeladryanmoldokkr32-pixel

mermaid-visualizer

Render text into Mermaid diagrams for Obsidian and GitHub.

Community
Advanced
benshapyrobenshapyro
9

documentation-templates

Generate README, API docs, and inline comment templates for software projects.

Community
Basic