OpenParable
Skip to content
← Back to skills

Documentation Information Architecture

Design
documentation-information-architecture

Documentation Information Architecture is an Agent Skill for design published in the hashgraph-online/awesome-codex-plugins repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Audit, organize, and redesign developer documentation information architecture, including content inventory, navigation, landing pages, sequences, hierarchies, webs, breadcrumbs, sidebars, metadata, redirects, migration, platform/tool selection, and maintainable IA decisions. Use when restructuring docs sites, improving findability, planning doc migration, evaluating docs tooling, or organizing large documentation sets.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/hashgraph-online/awesome-codex-plugins/blob/HEAD/plugins/LVTD-LLC/skills/skills/documentation-information-architecture/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/documentation-information-architecture, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

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

  1. Load guidelines.md to choose the smallest useful reference set.
  2. Identify user mental models, common tasks, and existing content inventory.
  3. Choose or combine sequence, hierarchy, and web structures.
  4. Use workflows/evaluate-doc-platform.md when choosing or migrating documentation tooling.
  5. Use workflows/audit-doc-ia.md for full IA audit or redesign.
  6. Preserve redirects, metadata, source decisions, and maintenance rules.

Default Output

When auditing or redesigning IA, return:

  1. Current-state findings - navigation, gaps, duplication, stale content, and findability issues.
  2. User model - major audiences, tasks, and entry points.
  3. Recommended structure - sequence, hierarchy, web, landing pages, and navigation cues.
  4. Content actions - keep, remove, review, merge, split, move, or create.
  5. Migration plan - redirects, metadata, owners, and validation.
  6. Maintenance plan - how IA decisions stay current.

Contents

NeedStart Here
Understand IA patternsreferences/core/knowledge.md
Apply IA rulesreferences/core/knowledge.md
See IA examplesreferences/core/knowledge.md
Audit or redesign IAworkflows/audit-doc-ia.md
Evaluate docs platform/toolingworkflows/evaluate-doc-platform.md
Route by taskguidelines.md

Core Posture

  • Organize docs around user mental models and tasks.
  • Use landing pages to route quickly, not to create marketing detours.
  • Keep navigation cues useful but economical.
  • Treat migration and maintenance as part of IA design.
  • Choose tools from reader, authoring, maintenance, and migration requirements rather than feature excitement.