How does the skill handle long documentation pages?

It provides specific guidelines for page length based on content type and suggests splitting pages that exceed 5 screens to maintain readability and focus.

What is the primary purpose of the Documentation Structure skill?

The skill provides blueprints and best practices for organizing technical documentation, ensuring that information is findable, scannable, and logically structured for the end user.

What navigation patterns does it support?

It supports breadcrumbs for hierarchy visualization, Prev/Next buttons for sequential content, and On-this-page section links for long-form content.

Does this skill help with writing the actual documentation text?

No, this skill focuses on structure and organization. For writing content, it is designed to be used in conjunction with skills like 'writing-functional-docs' or 'writing-api-docs'.

Can I use this for API reference organization?

Yes, it includes specific patterns for API references, including endpoint documentation structure and the strategic placement of request/response code examples.

Documentation Structure

Name: Documentation Structure
Author: LerianStudio

byLerianStudio

•

Aprendizaje y Documentación

Organizes and structures technical documentation using standardized hierarchies, navigation patterns, and information architecture best practices.

Acerca de

The Documentation Structure skill provides a comprehensive framework for planning and organizing software documentation to ensure clarity and findability. It helps developers and technical writers define logical content hierarchies, implement scannable page structures, and establish effective navigation patterns like breadcrumbs and sequential links. By prioritizing user tasks over internal system organization, it ensures that technical guides, API references, and conceptual overviews remain intuitive, consistent, and professionally formatted according to industry-standard quality gates.

Características Principales

Navigation design guidelines including breadcrumbs, sequential links, and on-page tables of contents
17 GitHub stars
Standardized content hierarchy for welcome guides, task-oriented docs, and API references
Information density optimization using scannable headings, progressive disclosure, and lists
Modular page structure patterns for conceptual, task-oriented, and overview pages
Strategic placement rules for code blocks, tables, and section dividers

Casos de Uso

Bootstrapping a new documentation project with a logical folder and file structure
Refactoring long, cluttered documentation pages into digestible, task-oriented segments
Establishing consistent navigation and cross-linking strategies across a complex documentation site

Acerca de

Características Principales

Navigation design guidelines including breadcrumbs, sequential links, and on-page tables of contents
17 GitHub stars
Standardized content hierarchy for welcome guides, task-oriented docs, and API references
Information density optimization using scannable headings, progressive disclosure, and lists
Modular page structure patterns for conceptual, task-oriented, and overview pages
Strategic placement rules for code blocks, tables, and section dividers

Casos de Uso

Bootstrapping a new documentation project with a logical folder and file structure
Refactoring long, cluttered documentation pages into digestible, task-oriented segments
Establishing consistent navigation and cross-linking strategies across a complex documentation site