免费注册,打造高效身份管理
博客/开发者/面向「开发者友好」设计 Authing 的开发者能力
面向「开发者友好」设计 Authing 的开发者能力
Authing 官方2022.09.23阅读 1311
Authing 的产品演进到了第三代,但无论到了第几代,核心的以开发者为中心都是贯穿全产品线的重要产品设计哲学。也就是说,不论将来 Authing 的产品如何演进,定位如何变化,「以开发者为中心」将像鱼骨一样,不论伸出多少分支,总有一个主线贯穿全程。
本文将解释以下问题:
  1. 【Why】何为开发者友好及对 Authing 意味着什么?
  2. 【How】如何设计好 Authing 的开发者友好能力?
  3. 【What】Authing 的开发者友好示例

01
开发者友好对 Authing 意味着什么?

开发者友好是 Authing 的战略、决心和诉求,是不能讨价还价的。 Authing By developers, for developers.
Authing 是一群由开发者开发的面向开发者的产品,我们生于开发者,成长于开发者,未来也将回馈开发者。我非常高兴地听到有客户说我看到你们赞助了 vue.js,如今采购了你们产品感到特别亲切」。
 
过去三年,Authing 所做的所有开发者向的内容营销没有打水漂,他们已经变成了一种潜在的情感注入,这种情感将会持续正向影响Authing的商业化增长。开发者友好是 Authing 的战略、决心和诉求,不论 Authing 的定位如何变化,这都不会变化。这也是我们为什么成立「API-First」部门实现全量能力接口化的原因。
 

02
何谓开发者友好以及基本原则

谈起开发者友好,可能很多人觉得抽象,如果具象一点,开发者友好具备以下几个基本原则:
  1. 保持简单
  2. 被动复杂
  3. 遵循常识
  4. 基于用户故事,耐心引导,改善学习/使用体验

 

保持简单
上周六,从北京到苏州的出差路上,我看完了一个系列的相对论视频,当我看完所有的解释再回过来头看E=mc²的时候,突然意识到越是简单的模型才能解释越复杂的问题」。
 
我们再看编程语言,编程语言的核心只有三个概念:
 
1. 循环语句 for
2. 逻辑语句 if
3. 函数 function
 
而就是这样简单的三个概念,产生了我们现在数字世界的万物。而道家说,一生二,二生三,三生万物,也是同样的道理。
 
保持简单是「开发者友好」的第一原则,那么什么叫保持简单呢?
 
比如在 Guard 中使用 Authing JS SDK,下图左边是 Guard 5.x 的用法,右边是 Guard 4.x 的用法,很明显 Guard 5.x 更简单此之谓保持简单,不给用户带来过多的心智负担和学习成本,以及所有的方法都非常语义化,易于理解。
 
添加图片注释,不超过 140 字(可选)
 
 
添加图片注释,不超过 140 字(可选)
 
比如通过一个语义化的标签完成整个复杂登录组件的初始化,屏蔽所有细节:
 
添加图片注释,不超过 140 字(可选)
 
 
添加图片注释,不超过 140 字(可选)
 
比如使用一套 API、一套 SDK、一套参数完成微信全生命周期打通,实现在微信生态内的 One ID、One Data、One Service。
 
添加图片注释,不超过 140 字(可选)
 
 
添加图片注释,不超过 140 字(可选)
 
 
再比如,Authing 的微信网页 SDK,将在微信网页内做好认证这件事抽象到了极致:
 
添加图片注释,不超过 140 字(可选)
 
 
开发者完全不用操心背后的流程,只需要调用语义化的接口。
 
被动复杂
做面向开发者的产品是很复杂的,因为开发者会利用原子化的能力拼装出更多创新业务,开发者要完成的是整个业务,所以不希望集成某个 SDK 时产生更大工作量,在这种情况下,我们就要尽量降低开发者的劳动成本,降低劳动成本不仅是开发成本,还有学习成本,所以一开始也不要给开发者灌输更多知识体系,而要做到:在需要复杂的时候主动告知复杂性。
 
比如,Authing 的登录接口,在开启 MFA 后,会返回1635错误码,并告知开发者该错误代码需要如何处理,并附上相关文档链接;这样,用户不需要主动学习 MFA 的集成接口,在需要 MFA 调试时可立刻获取到处理方式,这属于一种复杂性的被动通知,也会给到开发者惊喜感。
 
口碑也在此刻产生。
 
这种将复杂性藏在背后的设计对于掌控开发者预期将非常有帮助,这也将加速客户对 Authing 的产品采纳。
 
遵循常识
开发者的知识架构相当复杂,变化也非常多,在设计面向开发者的命令行或 SDK 时要符合在当前上下文中开发者最熟悉的常识。
比如,Authing Guard 的初始化会遵循不同的前端框架:
 
添加图片注释,不超过 140 字(可选)
 
 
 
添加图片注释,不超过 140 字(可选)
 
比如,Authing 会和更多编程框架做深度集成,以达到框架内的最开发者友好:
 
添加图片注释,不超过 140 字(可选)
 
基于用户故事,耐心引导,改善学习/使用体验
我们都知道,对于开发者工具,文档是比工具本身更重要的产品,如果没有好的文档,开发者根本不知道该如何下手。
开发者在阅读开发者文档时会经历以下旅程:
 
添加图片注释,不超过 140 字(可选)
 
只有当开发者发现我们提供的 API 满足他们需求时,他们才可能会去尝试使用它。当开发者产生尝试对接的想法时,我们的 Quickstart 决定了开发者是否能够快速上手。Quickstart 是我们与开发者最早的互动,这会给他们留下产品最初的开发者体验。产品的 Quickstart,是开发者是否持续使用我们的 API/SDK 的关键要素之一。
 
SDK/API 的接入,是 Authing 的生命线,像血液一样,一旦断流,就像人一样会死亡。
 
这种做好 Quickstart 的模式,是开发者产品达成 PLG(产品驱动增长)的最关键能力。但这需要多方面的支撑,比如需求、UI、参数设计、错误码等,只有搞清楚开发者为什么要用,才能更好地帮助开发者实现目标。
 
那么怎么设计好用的 API 帮助开发者提升接入体验呢?
 
答案是使用用户故事地图,以做一个登录系统为例,如下所示进行可视化表示:
 
添加图片注释,不超过 140 字(可选)
 
在没有 Authing 之前,用户需要至少 9 个流程且需要很多部门协作才能完成身份系统,拥有 Authing 之后,只需简化到三个大步骤即可完成目标,通过用户故事地图,就可以知道客户到底需要什么样的能力,以及我们该怎么简化用户的流程并形成文档:
 
添加图片注释,不超过 140 字(可选)
 
在梳理清楚用户故事后,我们将明确了解开发者将带着哪些问题,并循序渐进引导开发者使用我们的工具。其中,齐全的文档很重要,一份齐全的文档至少包含以下模块:
  1. 快速开始
  2. 详细的开发文档
  3. 最佳实践
  4. 示例代码
  5. 错误代码及错误处理
Authing 在这方面做得挺不错的:
 
添加图片注释,不超过 140 字(可选)
 
当然,改善体验的方法绝非只存在于文档、SDK 本身,还包含在使用过程中的体验,关于过程中的体验优化,可以参考第二条的「被动复杂」。

03
总结

开发者友好绝非一朝一夕,也绝非易事。开发者友好是一门综合了人性、技术、需求、用户体验的综合学问,切勿轻视,亦勿小看。唯有持有敬意,方可盈门。
 
2022-09-22 谢扬
 

关于 Authing

Authing身份云是国内唯一以开发者为中心的全场景 IDaaS 服务商,以身份及服务的云计算视角,基于多租户云原生架构,集成了所有主流身份认证协议,遵循不同国家和行业的合规性要求,在所有 SaaS 软件和数亿用户中建立高安全、高性能、高生产力的统一身份认证平台,支持所有企业和开发者便捷灵活接入,满足各类场景化需求。
 
2021 年,Authing 身份云获得了 2300 万美元 A 轮融资,由老虎环球基金领投,鼎晖 VGC(创新与成长基金)、声网 Agora、GGV 纪源资本和奇绩创坛跟投。
 
自 2019 年创立以来,凭借在身份领域的技术创新、产品优势与市场化方面等诸多突出表现,Authing 身份云获得了国内外众多权威机构的认可:
 
Authing 先后被《中国网络安全产业白皮书(2018)》《2019 年网络安全产品报告(安全产品全景图)》、《中国网络安全行业全景图(第九版)》收录;
 
添加图片注释,不超过 140 字(可选)
 
2019 年 9 月,Authing 以独家身份供应商入选中国信息通信研究院「卓信大数据第三批成员单位;科技部认定的「2021 国家高新技术企业」;中国信息通信研究院评选的「国内身份管理与访问控制领域创新企业」;
 
2021 年 8 月,Authing 入选福布斯亚洲「最值得关注公司」百强榜单,创始人谢扬入选福布斯亚洲 30 Under 30。
 
添加图片注释,不超过 140 字(可选)
 
2022 年 4 月,Authing 正式加入 W3C(万维网联盟)组织, 将参与 WebRTC、DID、Web 应用及安全、身份验证、JSON-LD、数据集交换、MiniApps 等国际互联网标准制定。
 
添加图片注释,不超过 140 字(可选)
 
2022 年 5 月,Authing 成功入选世界经济论坛(World Economic Forum)2022 年技术先锋榜单——全球 100 家最有前途的“技术先锋”(Tech Pioneer),中国大陆仅 15 家公司上榜。
 
添加图片注释,不超过 140 字(可选)
 
2022 年 6 月 15 日,Authing 获得云原生产业联盟颁发的「2022 年度云原生新锐企业」。
目前,Authing 身份云已帮助 20,000+ 家企业和开发者构建标准化的用户身份体系,感谢可口可乐、元气森林、招商银行、中国石油、三星集团、CSDN 等客户选择并实施 Authing 解决方案。
 
添加图片注释,不超过 140 字(可选)
 
 

文章作者

avatar

Authing 官方

0

文章总数

authing blog rqcode
关注 Authing 公众号
随时随地发现更多内容
authing blog rqcode
添加 Authing 小助手
加入 Authing 开发者大家庭
Online
Contact us online
To create a perfect identity system
WeCom
authing
Add Wecom to receive industry information
CEO-Mail
ceo@authing.cn
Direct feedback to the CEO
Free Trial
Online
Phone