在软件世界中,用户通过外观和感觉来判断应用程序。在软件世界中 发展,开发人员可以通过其文档来判断API的质量。根据定义,API没有用户界面,因此乍一看,该文档 是 用户体验。仅仅是API的用户就是软件开发人员。
最近 Mailchimp 走近Postlight并寻求帮助。他们为开发人员提供了两个功能强大且使用频繁的公共API:Mandrill和Mailchimp API。但是这两个API位于不同的网站上,具有不同类型的文档,看上去和感觉像它们来自不同的星球,对于Mandrill而言,似乎四年都没有维护或更新过。使用率正在降低,竞争对手的产品正在吸引开发人员,信任正在削弱,并且开发人员可用于与产品进行交互的工具和库中存在差距。
2020年初的Mailchimp和Mandrill API主页。
Postlight的职责很明确:要在一个地方统一Mailchimp的程序化产品,通过文档和工具提供一流的开发人员经验,并在此过程中将Mailchimp打造成为一家现代化的世界级技术公司。
我们合作的结果刚刚在 //mailchimp.com/developer。全新的Mailchimp Developer功能包括:
- 全新深色模式启发的外观
- 并存的重新命名的API:Marketing API(以前称为Mailchimp)和Transactional API(以前称为Mandrill)
- 完全重新设计和统一的最新技术 API参考,具有您选择语言的交互式代码段
- 新客户库 通过这两种API的多种编程语言,通过包管理器在各处分发
- 重写并刷新 开发人员指南 逐步指导开发人员逐步完成每个API的特定任务
- 全新的 发行说明 面积和 工程博客
- 专为开发人员优化的移动体验,可在旅途中查找答案或进行故障排除
- 开发人员特定的搜索功能,使开发人员可以轻松找到所需的内容
除了发射, Mailchimp向开发者认捐100万美元 建立与其API的集成以服务受COVID打击严重的中小型企业。
开发人员的位置,供开发人员使用
我们通过与用户交谈开始了这项工作。我们的产品设计团队采访了数十位开发人员,营销人员,与营销人员合作的开发人员以及与开发人员合作的营销人员。通过这些讨论,关键的见解指导了其余的工作: 开发人员不希望被推向市场。 他们是一个聪明,忙碌的专业人员,他们在截止日期前希望获得所需的信息,这些信息无所不能,以帮助他们构建有效的软件。
Mailchimp开发人员必须在一个欢迎,熟悉的地方,并且必须以他们的语言与开发人员交流。这个前提指导了每个视觉和用户体验选择以及我们的Mailchimp Developer内容策略。
新的Mailchimp开发人员于2020年8月启动。
我们听说(并从我们自己的经验中知道)您需要去开发人员已经去过的地方。作为此次发布的一部分,Mailchimp在一个 GitHub上的公共存储库。这意味着在整个Mailchimp Developer中,开发人员都可以看到“在GitHub上改进我们的文档”链接,这些链接鼓励他们在良性的协作周期中为文档提供建议和说明。
每种语言的工具
我们知道,在每种开发人员选择的编程语言中,能够快速开始使用API至关重要。 API参考以最常用的语言提供工作代码片段,从PHP到Node.js到Ruby,Python和cURL。
代码段可用于每个API端点。
Mailchimp和Postlight工程也已建成并发货 四种语言的全新SDK 这两个API,现在已成为 Mailchimp GitHub组织 并通过软件包管理器分发到各处。
像API参考一样,这些SDK是根据API规范自动生成的。规范更改时,将通过GitHub Actions自动重建和发布API参考和所有SDK。这样可确保工具和文档始终可靠地对齐并保持最新状态。利用代码生成工具,将来也可以更轻松地引入和维护其他语言的SDK。
Mailchimp的营销产品套件使出色的品牌可以与其客户和用户(包括 Postlight的时事通讯!)。现在,开发人员拥有文档和工具 他们 需要使更多的企业通过自定义集成和应用来为其客户提供服务。看看新的 Mailchimp开发人员,并告诉我们您的想法。
吉娜·特拉帕尼(Gina Trapani) (@ginatrapani)是Postlight的执行合伙人。想谈谈开发者的用户体验吗?保持联系: [email protected].