如何使用看板创建更好的文档

使用看板进行卡片分类可以设置您的内容,以便为用户提供他们正在寻找的信息。
440 位读者喜欢这篇文章。
Team operating principles: the open source way

Opensource.com

如果您正在编写文档、网站或其他面向用户的内容,那么了解用户希望找到什么——他们想要的信息以及信息的组织和结构方式——是非常有帮助的。毕竟,如果人们找不到他们正在寻找的东西,再好的内容也没有用。

卡片分类是一种简单有效的方法,可以从用户那里收集关于他们对菜单界面和页面的期望的输入。 最简单的实现方式是在一堆索引卡上标记您计划包含在您的网站或文档中的部分,并要求用户按照他们查找信息的方式对卡片进行排序。 变体包括让人们写自己的菜单标题或内容元素。

目标是了解您的用户期望什么以及他们期望在哪里找到它,而不是让他们自己去弄清楚您的菜单和布局。 当您在同一物理位置有用户时,这相对简单,但当您尝试从多个位置的人那里获得反馈时,这更具挑战性。

我发现 看板 是在这些情况下使用的绝佳工具。 它们允许人们轻松地拖动虚拟卡片来分类和排序它们,并且它们是多用途的,不像专用的卡片分类软件。

我经常使用 Trello 进行卡片分类,但您可能想尝试一些 开源替代方案

它是如何工作的

我最成功的看板实验是在我为 Gluster 编写文档时,Gluster 是一个免费和开源的可扩展网络附加存储文件系统。 我需要将随着时间推移而增长的大量文档分解为类别,以创建一个导航系统。 因为我没有必要的技术知识来对其进行排序,所以我向 Gluster 团队和开发者社区寻求指导。

首先,我创建了一个共享的看板。 我给列赋予了一般的名称,以便进行排序,并为我计划在文档中涵盖的所有主题创建了卡片。 我用不同的颜色标记了一些卡片,以表明某个主题缺失需要创建,或者它已经存在需要删除。 然后我将所有卡片放入“未分类”列,并要求人们将它们拖到他们认为应该组织卡片的位置,并向我发送他们认为理想状态的屏幕截图。

Example of a kanban board for card sorting

opensource.com

处理所有屏幕截图是最棘手的部分。 我希望有一个合并或共识功能可以帮助我汇总每个人的数据,而不必检查一堆屏幕截图。 幸运的是,在第一个人对卡片进行排序后,人们或多或少同意该结构,并且只进行了小的修改。 当人们对某个主题的放置有不同意见时,我会安排快速会议,人们可以在会上解释他们的想法,我们可以解决分歧。

使用数据

从这里,很容易将我捕获的信息转换为菜单并对其进行改进。 如果用户认为项目应该成为子菜单,他们通常会在评论中告诉我,或者在我们通过电话交谈时告诉我。 对菜单组织的看法因人们的工作任务而异,因此您永远不会完全达成一致,但与用户进行测试意味着您不会对人们使用什么以及他们将在哪里寻找它有那么多的盲点。

将卡片分类与分析结合使用可以让您更深入地了解人们在寻找什么。 有一次,当我对我正在编写的一些培训文档进行分析时,我很惊讶地了解到搜索次数最多的页面是关于标题大小写的。 所以我在顶部菜单级别显示了该页面,即使我的“逻辑”设置将其放在子菜单的底部。

我发现看板卡片分类是一种帮助我创建用户想要看到的内容并将它们放在他们期望找到的位置的好方法。 您是否找到了另一种为用户利益而组织您的内容的好方法?或者看板的其他有趣的用途? 如果是这样,请在评论中分享您的想法。

A pink-haired woman with a half-smile looks directly into the camera.
Heidi 是一位技术作家、演讲者和开发者教练,她正在扩大她的写作和行业专业知识,以帮助更多人成为更好的作家。 她目前的热情包括自动化文档、文档驱动的开发以及将口袋缝到她所有的衣服上。

3 条评论

这是一个有趣的方法。
另一个逻辑层是在您决定了一个基本结构之后,在文档内部创建交叉链接,这样您就不必总是返回到上层然后再向下。 例如,可能有很多与已知问题的连接。

你好 Heidi! 我非常喜欢你使用看板的方式。 看到它有多少应用真是太迷人了! 如果您正在寻找更多灵感和技巧,这里有一个很好的来源: https://kanbantool.com/blog 尽情享受吧!

Creative Commons License这项工作是在 Creative Commons Attribution-Share Alike 4.0 International License 下获得许可的。
© . All rights reserved.