开源项目中的用户体验写作

用户体验写作在开源中至关重要,因为它可以帮助用户快速掌握你的信息和意图

在从事了一些开源 Web 开发工作后,我对这个概念做了一些研究,因为我想扩展我在这方面的技能

在你阅读之前

每个用户体验作家都需要的三件事

  • 创造力
  • 解决问题
  • 共情
  • 用户体验写作对于数字产品中清晰、用户友好的沟通至关重要。它涉及编写简洁、以用户为中心的文本,引导用户浏览界面,就像记笔记一样,便于快速理解。一个关键挑战是解决多样化的用户群,需要具有包容性的写作,引起所有人的共鸣。问题仍然存在:如何通过更好的用户体验写作让开源项目对开发人员和用户都更具吸引力?为了实现这一点,用户体验作者可以利用各种工具来提高清晰度和可访问性。

    那么我的观众是谁?

    简短回答:视情况而定

    长答案:受众主要来自两个分支,非技术用户和技术用户。可能的受众包括开发人员、设计师、测试人员或想要尝试新事物的业余爱好者。了解受众的主要方法是阅读产品内容,并富有同理心地解决不同写作水平的问题。

    我认为最多保持在 7 年级的阅读水平,因为这是阅读速度最快、最简单的

    UX 写作的主要原则

  • 清晰度:避免使用行话和缩略词,使用直白的语言,以便于翻译
  • 可访问性:确保文字适合屏幕阅读器
  • 中立性:使用性别中立的语言,避免使用特定文化的习语
  • 鼓励:积极地构建错误消息和入门说明,你总会从积极性中得到积极的反馈,甚至在与人工智能交谈时也能发挥作用——这是一项快速工程的技能
  • 开始为开源平台编写代码(重要文件摘要)

  • 自述文件:使用标题和项目符号列表以便于导航
  • 文档:假设没有任何先验知识,使用常见问题解答和故障排除部分编写分步说明
  • 错误消息:指定错误是什么,避免使用技术性指责语言
  • 贡献指南:提供精心编写的拉取请求描述或提交消息的示例,以明确贡献者的期望
  • 鼓励社区合作

  • 提供有用的提交信息
  • 在代码上添加注释,以便贡献者能够理解它的作用以及为什么进行更改
  • 用户体验写作工具概述

  • Grammarly、Vale 或 Write Good 等用于文档的 Linter 工具可以帮助增强清晰度和语气一致性
  • 风格指南重点突出了首选术语和语气等关键点
  • 真实示例

  • 之前:“错误:输入无效”
  • 之后:“哎呀!我们无法处理您的输入。请确保其符合以下格式:YYYY-MM-DD”
  • 工具列表

  • 对于用户体验写作,用户体验写作助手:一款与 Google Docs 集成的插件,可确保您的写作符合用户体验最佳实践,例如语气和一致性。Google 用户体验写作手册:提供来自 Google 用户体验团队的实用指导和示例
  • 用于嵌入 UX 写作 Figma:使您能够与设计师协作并实时测试微文案 Sketch:非常适合了解您的文字如何融入界面组件 Adob​​e XD:允许您制作原型设计并查看您的副本在用户界面中的工作方式
  • 我推荐的订阅

  • dailyuxwriting:用于用户体验写作练习,熟能生巧,我将在此基础上撰写后续文章 ^
  • Growth.Design:通过有趣的漫画了解有关 UX 工具和案例研究的更多信息
  • 结论

    UX 写作是一项必不可少的技能,它能让开源项目更容易理解、更吸引人。通过注重清晰度、可访问性和社区协作,UX 作家可以创造迎合不同受众的用户友好体验。无论是优化 README 文件、改进错误消息,还是设计包容性文档,周到的 UX 写作都能发挥重要作用。利用讨论的工具和原则来增强您的贡献,并为开发人员和用户创造一个诱人的环境。