documentation-information-architecture
Documentation Information Architecture
Use this skill to organize developer documentation so readers can find the right content at the right time. It works at doc-set and site level rather than single-page prose level.
This skill is derived from Docs for Developers: An Engineer's Field Guide to Technical Writing, especially Chapter 10, "Organizing documentation." It is expanded with paraphrased guidance from Christopher Gales and the Splunk Documentation Team's The Product Is Docs: Writing Technical Documentation in a Product Development Group, especially Chapter 17, "Tools and Content Delivery," plus related audience, learning-objective, maintenance, and SaaS guidance from Chapters 3, 9, 10, and 25. Do not copy book prose into user outputs. Source: https://link.springer.com/book/10.1007/978-1-4842-7217-6
Quick Start
- Load
guidelines.mdto choose the smallest useful reference set. - Identify user mental models, common tasks, and existing content inventory.
- Choose or combine sequence, hierarchy, and web structures.
- Use
workflows/evaluate-doc-platform.mdwhen choosing or migrating documentation tooling. - Use
workflows/audit-doc-ia.mdfor full IA audit or redesign. - Preserve redirects, metadata, source decisions, and maintenance rules.
Default Output
When auditing or redesigning IA, return: