【问题标题】:How to find appropriate person for API feature review?如何找到合适的人进行 API 功能审查?
【发布时间】:2009-04-14 14:12:12
【问题描述】:

我们正在开发一个提供API接口的产品,以便其他开发者可以使用主产品的一些功能。

这已经实现并记录在案。

但我不确定这是否非常有用,并且文档对于开发人员来说非常清晰。

我们如何找到评论此功能的人? 应该是什么样的人?

从某种意义上说,我们正在为单一功能/组件寻找产品负责人。有可能吗?

【问题讨论】:

    标签: usability business-logic review


    【解决方案1】:

    最好找一个已经为相关语言设计了一些已知框架的程序员。

    我认为您的用户认为无关紧要,因为您无法通过询问任意程序员的观点来判断框架。他的答案将取决于他的知识水平和个人方法,而 API 是为更广泛的人群设计的(我假设这是你的情况)。为了完成这一点,在我公司使用 VB.NET 的程序员认为 C# 是蹩脚的语言,因为你不能在 C# 中编写 Button = "Text" 并让编译器自动为你找到默认属性。你不希望这样的人评判你的框架。

    即使是具有不同语言经验的设计师也可能会有所帮助,因为更广泛使用的 API 应该在人们已经熟悉的众所周知的编程模式的帮助下实现。

    【讨论】:

      【解决方案2】:

      让对您的产品没有经验的人为您的 API 制作一些示例代码或客户端的参考实现。然后他们会很好地了解文档的不足之处或 API 需要改进的地方。这可以是承包商,也可以是新开发人员(让他们跟上进度的好方法)。

      【讨论】:

        【解决方案3】:

        首先,如果您正在开发供他人使用的 API,我建议您阅读以下书籍:http://www.amazon.com/Framework-Design-Guidelines-Conventions-Development/dp/0321545613

        在需要进行任何审查之前,遵循这些规则将避免您的界面出现大量可用性问题。

        其次,对一些目标开发人员进行可用性研究,这些开发人员可能会使用此 API,但以前从未见过它。把他们放在系统前面,给他们一些任务,然后观察他们是如何弄清楚如何去做的。他们的痛点会告诉您需要改进的地方。

        【讨论】:

          【解决方案4】:

          调查您的最终用户并找出哪些用户正在使用您的 API 与您的软件进行交互。然后,您可以调查这些用户,并了解他们对您在 API 中提供的各种功能以及文档的易用性和清晰度的看法。

          【讨论】:

            【解决方案5】:

            每个 API 都有一些目标受众(即开发与您的产品集成的客户)。从这个角度来看,最好从这些观众那里获得反馈。您可以建立一些早期访问程序,或发布一些公共测试版。

            如果您没有这样的受众(即您正在为尚未公开的产品开发 API),我建议您进行一些“可用性测试”之王 - 即选择一个具有大致目标受众技能的开发人员并提供他做了一些涉及 API 使用的任务。然后得到他的反馈。

            【讨论】:

              【解决方案6】:

              如果我站在你的立场上,我会开始编写示例应用程序,或者做一个演示来引导人们完成这些步骤,或者做一些其他类似的练习。它不如从用户那里获得反馈,但它可以解决一些问题。

              另一个(可能是坏的)想法是在 elance/guru 网站上花钱,并提出一个您认为代表用户将如何使用 API 的示例应用程序/功能。为此创建项目,然后作为项目的一部分从开发人员那里获得反馈。

              您可能会想要可以用您的母语交流的人...

              顺便说一句,等到所有文件都记录下来并实施可能不是审查它的最佳时间……在实施之前进行审查会好得多。

              【讨论】:

                猜你喜欢
                • 1970-01-01
                • 2013-05-23
                • 2021-10-18
                • 2019-11-14
                • 1970-01-01
                • 2021-06-28
                • 2015-12-07
                • 2013-04-10
                相关资源
                最近更新 更多