skills.rest
dtaborda
dtabordaCOMMUNITY
Explore all skills by this author →
GitHub

documentation

Enforce unified documentation style for startup-saas-template MDX and README files.

Updated Mar 30, 2026
Search Tags:#documentation#mdx#style-guide#architecture-docs#brand-voice#developer-docs
One-click install
npx skills add https://github.com/dtaborda/startup-saas-template --skill documentation-dtaborda
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/dtaborda/startup-saas-template/tree/main/skills/documentation
Command: npx skills add https://github.com/dtaborda/startup-saas-template --skill documentation-dtaborda

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Establishes consistent documentation tone, structure, and medium-specific rules so every README, MDX page, or developer guide matches the startup-saas-template voice and inclusion standards.

Core Features & Use Cases

  • Brand Voice Enforcement: Prescribes neutral language, inclusive terminology, and English-only copy for every piece of developer-facing documentation.
  • Structure & Formatting Control: Defines the required section order, Title Case headers, hyphenation rules, and callout usage that keeps architecture and feature documents organized.
  • MDX & Reference Standards: Covers MDX frontmatter, Mermaid diagrams, code blocks with context, and callout conventions so writers can deliver predictable documentation; use this when updating the Lighthouse Architecture MDX page or README to match the project canon.

Quick Start

Draft documentation following the Uniform Section Contract, brand voice, and MDX requirements for the feature you are explaining.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I enforce a consistent documentation style guide across MDX files?▼

You can enforce a documentation style guide by applying prescribed rules for MDX frontmatter, Title Case headers, ordered sections, and callout conventions so every page matches the project canon.

What is the required structure for developer-focused architecture docs?▼

Required structure for developer-focused architecture docs includes a uniform section order, Title Case headers, inclusive language, and defined callout or Mermaid diagram conventions to keep feature documents organized.

How do I write README files that match a unified brand voice?▼

Write README files that match a unified brand voice by using neutral language, inclusive terminology, and English-only copy while following the established hyphenation rules and section ordering requirements.

Does this documentation style guide support Mermaid diagrams and code blocks?▼

Yes, the documentation style guide supports Mermaid diagrams and code blocks with context, prescribing specific MDX frontmatter and diagram conventions to deliver predictable developer reference standards.

When do I need to use defined callout conventions in MDX documentation?▼

Use defined callout conventions in MDX documentation when updating architecture guides, README files, or developer feature pages to ensure content remains organized and consistent with the project canon.

Related Skills

Explore More Content & Communication Skills→
professor-moodyprofessor-moody
1

prowler-docs

Enforce Prowler documentation style, terminology, and MDX formatting standards.

Community
Basic
Thanh-aperoThanh-apero
1

ck:mintlify

Build documentation sites from Markdown/MDX files using the Mintlify CLI.

Community
Advanced
KrystianYCSilvaKrystianYCSilva

markdown-expert

Create Markdown documentation with Mermaid diagrams and GFM tables.

Community
Intermediate
8GG-Git8GG-Git

brand-voice

Enforce brand voice, style guide, and messaging pillars across content.

Community
Intermediate