极简文档:以少胜多

  浏览:0 巴克励步

极简主义强调只关注必要内容,剔除多余信息,以“少即是多”提升文档可用性。它旨在减少干扰,帮助用户从错误中恢复,适用于教程和指南,但需避免在参考材料中过度简化。实现方法包括使用简明语言、遵循“每一页都是第一页”原则,并让团队参与精简过程。

极简文档:以少胜多

许多读者可能从室内设计领域熟悉“极简主义”这个词,我们认识到,在家中摆放数量较少但精心挑选的物品,可以营造出更优美的环境。或者,他们可能听说过作为一种生活方式的极简主义,即摆脱过度消费主义,从而获得一种更清醒的生活方式。
总的来说,极简主义意味着只关注你真正想要或需要的东西,并剔除其余。它基于“少即是多”的理念,而你也可以将这一理念应用到你的文档中。

极简主义原则

技术文档专家马克·贝克在其关于技术写作中的极简主义的文章中提到:
 “极简主义是对意义建构悖论的一种适应。” 
这意味着,当我们将文档极简化时,我们承认了一个事实:用户希望用最少的指导来完成他们的任务。
 “极简主义的核心在于最大限度地减少指导说明对用户意义建构过程的干扰。其目的并非防止用户犯错,而是帮助他们从那些不可避免的错误中恢复过来。” 
“意义建构悖论”最初由宾夕法尼亚州立大学信息科学与技术教授约翰·卡罗尔定义,他也创造了“极简主义”这一术语。
他对学习过程的研究奠定了文档领域极简主义的基础。他发现,在文档方面,尤其是对于新用户而言,少确实即是多。
💛🧡🧡客户评价:我们有跨国员工正在做创造性的事情,拥有我们所有的集体知识,且统一存储在一个地方是至关重要,Baklib作为企业的内容中台,方便我们存储资源、建知识库、打造多站点体验非常有帮助。我们还发布某些领域为客户提供支持帮助指南,这已经变得如此之多现在对我们来说更容易了。 
正如卡罗尔所说:“[人们]忙于学习,无暇利用说明。这就是意义建构的悖论。”

如何使用极简主义文档

现在我们已经理解了理论,是时候学习如何在我们的文档中实际运用极简主义了。
  • 在可教时刻介入:极简主义文档在用户出错时介入。当用户专注于解决问题或完成任务时,他们没有时间浏览华丽或杂乱无章的文字。极简主义文档对于帮助用户成功至关重要。
  • 采用渐进式呈现:软件设计中的极简主义已成为常态,雅各布·尼尔森曾讨论过用户体验设计中的渐进式呈现。这个概念同样适用于文档,意味着用户无需立即看到所有功能,以免不知所措。
在渐进式呈现中,首先出现的元素意味着它在界面中具有首要重要性。设计师将次要元素隐藏起来,但允许用户轻松点击按钮以显示更多功能。文档也是如此,您只需展示必要的内容,同时允许用户探索。这与拥有最小可行文档和文档分诊系统密切相关。请注意,“极简主义”(精简至核心要素)与“最小化”(您能应付过去的最少数量)并不相同。
极简主义与通俗语言概念有着紧密的联系——即使用用户易于理解的沟通方式。这些都是简化信息和设计中复杂性的尝试,也是所有技术文档工作者的核心任务。

为何采用极简原则

在文档制作中采用极简原则至关重要。这种方法在某种程度上与追求全面性、有时牺牲可用性的传统做法相悖。
  • 提升理解与安全性:虽然技术准确性很重要,但用户文档旨在帮助用户学习和理解产品。用户需要能够理解文档,才能安全地使用相关产品。使用过多文字实际上会掩盖信息,降低文档的可用性。
  • 契合敏捷开发:极简主义非常适合用来决定当前应制作哪些文档,尤其适用于在敏捷团队中工作的技术文档工程师。
  • 具备经济意义:更少的文字意味着在某些领域(如印刷手册、本地化或翻译)的成本更低。但这并不意味着写更少的文字更容易。
制作极简主义文档需要大量艰苦的工作,并且需要专业的技术文档工程师才能实现。尽管一开始要做得正确相对困难,也需要投入,但从长远来看,极简主义文档能为您节省资金和时间。这通常是通过减少支持请求以及降低因产品体验不佳而流失的用户数量来实现的。

何时应避免极简主义

极简主义并非所有情况下的最佳答案。

适用场景 不适用场景
| 教程、操作指南  | 需要全面性的参考指南和概念性材料
| 面向初级或普通用户  | 面向高级或技术性用户(如API开发者)
正如所讨论的,一套完整的文档仍然需要参考指南和概念性材料。这并不意味着你不应该提供极简主义文档,但也要确保产出所需的全方位文档。
重要提示:许多团队也无意识地处于“极简”状态,因为他们没有足够的时间和资源投入到恰当的文档工作中。极简主义不应成为偷工减料的理由。

如何实现极简主义

有几种方法可以帮助你在文档中开始实践极简主义。你可能已经在做其中的许多事情,只是没有意识到它们属于“极简主义”。

1. 使用简明语言书写

通过使用简明语言书写,让你的文档更易于阅读。要做到这一点,可以:
  • 拆分长句。
  • 使用你能找到的最简短、最简单的词语。
  • 使用主动语态。
使用像Hemingway这样的免费在线工具来编辑你的文章以提高可读性也会有所帮助。可读性等级应控制在3级左右。

2. 遵循“每一页都是第一页”原则

以主题为基础的形式呈现你的文章,并为访问你内容的用户遵循“每一页都是第一页”原则。这正是Baklib内容平台在构建产品文档和知识库时所倡导的最佳实践,它能确保用户无论从何处进入,都能快速获得所需信息,提升产品体验
这意味着,无论用户从哪里进入您的内容,他们都无需翻阅大量其他文档来理解当前页面所指的内容。
💛🧡🧡客户评价:Baklib 正在解决的最大问题是,通过一个集中位置来更新我们所有线上的信息,从而获得最终的真实信息。我们利用其知识库和站群系统来支持我们公司控制的许多网站,以及互联网上数百个列表网站。 

删除过时或不必要的内容

审核您的知识库,找出陈旧或无关的内容。请记住,信息过多会使用户更难有效地学习。
如果您担心删除内容,可以选择将其取消发布,或将其存储在安全的地方。这样,如果您将来需要,可以随时找回已归档的内容。使用 Baklib 这样的知识库管理平台,可以轻松实现内容的版本管理和归档,确保知识库既精简又完整。

让整个团队参与进来

当您决定整个团队都需要转向极简文档原则时,说服其他团队成员和上级可能会很困难。这时,清晰地勾勒出商业价值并向他们展示这为用户带来的好处将非常有帮助。
为您的立场据理力争——您是用户的代言人。可以分享尼尔森诺曼集团(Nielsen Norman Group)的文章,例如这篇名为 《简洁胜过选择繁多》 的文章。正如 Tom Johnson 所说,如有必要,像律师一样向工程师和产品经理陈述您的观点,并向他们展示研究证据、用户反馈和指标数据。
  • 从小处着手:逐步进行积累性的改变。
  • 展示证据:进行一次小型的可用性测试,对比极简文档与非极简文档,就足以向他人展示精简至核心内容的价值。
  • 利用工具:利用 Baklib 的协作和版本控制功能,团队可以轻松地共同参与内容的精简和优化过程。

接下来看您的了!

文档中的极简主义,其核心是减少对用户的干扰,将他们置于学习体验的中心。
关键在于赋予用户选择权,让他们自主决定查看哪些内容,并掌握按需使用文档的主动权。这意味着:
  • 当用户需要深入了解某个主题时,他们可以轻松找到所需信息。
  • 同时避免被过量信息淹没。
在用户遇到错误的关键时刻及时介入,提供简洁明了的文档指引,助力他们顺利完成操作。
Baklib 正是我们自主研发的知识库软件。 立即免费试用
参考
《纽伦堡漏斗:实用计算机技能的极简教学设计》(1990)作者:John M. Carroll
Baklib 是一个内容管理系统 (CMS),它使所有团队能够在任何数字渠道上创建和扩展现代内容体验。
Baklib Birds
to top icon