ring:writing-functional-docs

What problem does it solve?

Patterns and standards to create consistent, high-quality functional documentation for guides, conceptual explanations, tutorials, and best practices.

Core Features & Use Cases

• Writing patterns: Lead with value, use second person, present tense, action-oriented headings, and short paragraphs to produce clear, task-focused docs.
• Visual and structural guidelines: consistent sectioning, info boxes, warnings, and linked references to improve scanability and reuse.
• Governance and guardrails: mandatory standards loading, blocker criteria, and quality checklists to ensure documentation meets audience needs.
• Reuse and orchestration: templates and patterns for conceptual docs, getting started guides, how-tos, and best-practices materials across teams.

Quick Start

Load the mandated standards (ring:voice-and-tone, ring:documentation-structure) and begin creating functional documentation following the provided patterns.