我们知道大部分用户都希望能更容易的反馈关于Unity文档的建议,所以我们做了个实验来看看它是否可行。
为了获悉我们能从社区得到何样的反馈,我们在官方手册页增加了“Suggest a Change”功能。该功能在整个八月期间有效。页面如下:
我们想了解我们能收到一些什么样的反馈以及我们如何用最好的方式来解决它。8月期间,我们通过这种方式收到了大约500条建议。下面是一些常见主题:
C#示例及消除转换错误
我们收到的最常见的反馈就是脚本API文档中缺少C#示例。你可以在 Unity脚本语言这篇博文中看到,我们一直在关注各脚本语言的使用率。鉴于我们大多数的用户都是使用C#语言,而我们为UnityScript提供的内部工具支持还缺少一些功能,所以我们对Unity 5的文档作出了以下决定:
C#将作为文档中示例代码的默认语言
我们将会开发一款新的的C#-to-UnityScript转换工具,它将在转换后保留原有代码的注释(我们代码示例的另一个意见集中点),并且解决旧转换器的其它问题。
你可能也注意到,我们的Learn Team在新的示例资源中使用的是C#语言,该资源将在Unity 5中取代先前版本的Standard Packages。我们坚信转向C#然后结合新转换工具的支持,将为用户们提供更高质量的文档。我们所希望的就是为你们提供更有价值更实用的代码示例。
减少失效链接
在Unity4.5的文档中,我们加入了自动链接验证,但鉴于4.5版本中我们收到的失效链接数(约100条)反馈,我们发现它只是在构建中内部报告了失效链接。对于Unity 5,我们的目标是减少无效内部链接的数量,甚至将该数字降至0,关于这点,我们已经制定了一个内部的流程以确保减少失效链接。
展望未来
我们从为期一个月的“Suggest a change”功能中得到的反馈是非常有价值的,我们也从中得知社区中存在大量有兴趣帮助我们改善文档的用户。目前,我们正在考虑未来如何执行它。我们很可能在随后以某种方式重新推出“Suggest a change”功能。
Is this article helpful for you?
Thank you for your feedback!