ring:documentation-structure

This skill provides a robust framework for structuring technical documentation, ensuring that content remains accessible, scannable, and logically organized based on user tasks rather than internal system architecture. It is designed for technical writers, software engineers, and AI agents tasked with maintaining project knowledge bases, API references, and user guides. By enforcing specific patterns, it minimizes cognitive load and improves information retrieval for end-users.

• Content Hierarchy: Implements a standardized tree structure starting from Welcome pages to API references and changelogs.

• Page Structure Patterns: Defines specific templates for Overviews, Conceptual documentation, and Task-oriented guides.

• Navigation Strategy: Provides rules for breadcrumbs, sequential 'prev/next' navigation, and on-page section links.

• Information Density: Sets standards for scannability, including guidelines for bullet points, tables, and bolding key terms.

• Progressive Disclosure: Encourages placing essential information first, followed by advanced configurations and edge cases.

• Quality Assurance: Includes a mandatory checklist to prevent orphan pages and ensure content relevance.

• Cross-linking Strategy: Optimizes internal link placement to avoid over-linking while ensuring seamless movement between conceptual docs and API endpoints.

• Strictly organize content by user mental models and tasks, not system components.

• Mandatory use of section dividers (---) to separate major topics and improve readability.

• Overview pages must always contain linked lists of child content to prevent navigation dead-ends.

• Before reorganization, verify current information architecture and ensure content inventory is complete.

• Use tables for structured comparisons and lists for sequence-based task steps.

• Always explain code examples immediately after their implementation references.