scaffolding-page-archetypes

To structure documentation pages using the Diataxis framework, you apply pre-defined structural templates called archetypes. These templates define required sections, content slots, and ordering to ensure consistent page anatomy across your documentation project.

Available page templates for standardizing documentation creation include Quickstart, How-To, API Reference, Webhooks, and Troubleshooting archetypes. Each template provides a structural skeleton with specific content slot definitions for archetype-specific organization.

You generate a Quickstart template for a new documentation project by applying the scaffolding archetype designed for Quickstart pages. This produces a correctly structured skeleton enforcing the required sections and content slots for that specific page type.

Yes, you can use page archetypes to enforce required sections for an API Reference page. The archetype generation process defines the specific page anatomy and content slot ordering needed to maintain structural consistency for API documentation.

Yes, this scaffolding approach works for both Troubleshooting and How-To guides. It generates structural skeletons tailored to each page type, applying specific content organization and anatomy enforcement to satisfy the Diataxis alignment requirements.

You need to use documentation archetypes instead of writing pages from scratch when starting a new documentation project or adding new pages. Archetypes provide pre-defined structural templates that enforce adherence to specific page anatomy and ensure content consistency.