documentation-information-architecture
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.
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 1.6k
- Forks
- 491
01 前言 Front Matter
- name
- documentation-information-architecture
- license
- MIT
- metadata
- { "tags": "developer-docs,technical-writing,documentation,information-architecture,navigation", "version": "0.1.0", "category": "Writing", "displayName": "Documentation Information Architecture" }
- description
- 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.
- compatibility
- Codex, Claude Code, and other Agent Skills-compatible clients.
02 资源文件 4
- 参考文档guidelines.md1.8 KB
- 参考文档references/core/knowledge.md7.8 KB
- 参考文档workflows/audit-doc-ia.md1.9 KB
- 参考文档workflows/evaluate-doc-platform.md2.8 KB
03 SKILL.md 正文
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:
- Current-state findings - navigation, gaps, duplication, stale content, and findability issues.
- User model - major audiences, tasks, and entry points.
- Recommended structure - sequence, hierarchy, web, landing pages, and navigation cues.
- Content actions - keep, remove, review, merge, split, move, or create.
- Migration plan - redirects, metadata, owners, and validation.
- Maintenance plan - how IA decisions stay current.
Contents
| Need | Start Here |
|---|---|
| Understand IA patterns | references/core/knowledge.md |
| Apply IA rules | references/core/knowledge.md |
| See IA examples | references/core/knowledge.md |
| Audit or redesign IA | workflows/audit-doc-ia.md |
| Evaluate docs platform/tooling | workflows/evaluate-doc-platform.md |
| Route by task | guidelines.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.
04 同仓库更多 Skills
worktable-review-with-annotations
Create, inspect, reply to, update, or resolve situated Worktable annotations. Use when feedback belongs to a Doc section, block, text range, or HTML Doc, or when the user asks to address existing review feedback and coordinate a requested artifact edit.
worktable-find-and-synthesize-context
Find, assess, and synthesize context from Worktable Docs and Records. Use when the user asks what a workspace contains, wants workspace-backed research, needs current facts reconciled across artifacts, or requests a cited synthesis without changing workspace state.
worktable-create-or-update-docs
Create, edit, rename, or maintain narrative Worktable Docs. Use for plans, decisions, briefs, notes, research syntheses, and other durable prose when the user requests a new artifact or a safe update to an existing one.
worktable-create-or-manage-records
Organize repeated structured information as durable Worktable Records. Use for research datasets, inventories, directories, pipelines, trackers, and other collections whose items need identity, fields, filtering, links, validation, or individual updates.
worktable-create-or-manage-interactive-html
Create or improve durable visual and interactive artifacts in Worktable. Use for dashboards, trackers, calculators, mini apps, slide presentations, and other requests that benefit from a polished HTML Doc.
worktable-collaborate-threads
Read, answer, and hand off messages through durable Worktable threads with users or other authenticated participants. Use when the user asks to check addressed messages, reply to a participant, continue a thread, request another agent's help, wait briefly for a response, or watch for comments and messages sent to the agent.