mcpField
D
documentation-information-architecture

documentation-information-architecture

github.com/lvtd-llc文档处理145 次安装7 周前更新
代码仓库

关于 documentation-information-architecture

用于规划整套开发者文档或文档站点的信息架构,而非修改单篇内容。它涵盖 IA 审查、重构、平台评估及后续维护。

主要功能

  1. 01文档信息架构模式与指南
  2. 02整站 IA 审查与重构流程
  3. 03文档平台评估流程
  4. 04迁移与维护规划

适用场景

  1. 01重构开发者文档站点
  2. 02查找文档缺漏与重复内容
  3. 03评估或迁移文档工具

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/lvtd-llc/skills --skill documentation-information-architecture

安装后在 Claude Code 中输入/documentation-information-architecture确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

guidelines.md
references/core/
knowledge.md
workflows/
audit-doc-ia.md
evaluate-doc-platform.md

详细介绍

文档信息架构

使用此技能组织开发者文档,让读者在恰当的时间找到合适的内容。它适用于文档集和网站层面,而非单页文案层面。

此技能改编自 Docs for Developers: An Engineer's Field Guide to Technical Writing,尤其是第 10 章“组织文档”。此外,还结合了 Christopher Gales 和 Splunk Documentation Team 所著 The Product Is Docs: Writing Technical Documentation in a Product Development Group 中经过转述的指导,尤其是第 17 章“工具与内容交付”,以及第 3、9、10 和 25 章中与受众、学习目标、维护和 SaaS 相关的指导。请勿将书中的原文复制到面向用户的输出中。来源:https://link.springer.com/book/10.1007/978-1-4842-7217-6

快速入门

  1. 加载 guidelines.md,选择最精简且实用的参考资料集。
  2. 确定用户心智模型、常见任务和现有内容清单。
  3. 选择或组合顺序式、层级式和 Web 式结构。
  4. 选择或迁移文档工具时,使用 workflows/evaluate-doc-platform.md。
  5. 全面审核或重新设计信息架构时,使用 workflows/audit-doc-ia.md。
  6. 保留重定向、元数据、源文件决策和维护规则。

默认输出

审核或重新设计信息架构时,请返回:

  1. 现状发现 - 导航、内容缺口、重复、过时内容和可查找性问题。
  2. 用户模型 - 主要受众、任务和入口点。
  3. 推荐结构 - 顺序、层级、Web、着陆页和导航提示。
  4. 内容处理措施 - 保留、删除、审核、合并、拆分、移动或创建。
  5. 迁移计划 - 重定向、元数据、负责人和验证。
  6. 维护计划 - 如何确保信息架构决策始终有效。

内容

需求从这里开始
了解信息架构模式references/core/knowledge.md
应用信息架构规则references/core/knowledge.md
查看信息架构示例references/core/knowledge.md
审核或重新设计信息架构workflows/audit-doc-ia.md
评估文档平台或工具workflows/evaluate-doc-platform.md
按任务导航guidelines.md

核心原则

  • 围绕用户心智模型和任务组织文档。
  • 使用着陆页快速引导用户,而非设置营销式的绕路内容。
  • 导航提示要实用而精简。
  • 将迁移和维护视为信息架构设计的一部分。
  • 根据读者、撰写、维护和迁移需求选择工具,而非被令人兴奋的功能所吸引。

评论

支持 Markdown