unity5离线文档下载
我们已经收到了想要更轻松地反馈有关Unity文档的用户的请求。 因此,我们进行了一项实验,以了解它如何工作。 (We have been getting requests from users who want to feedback on Unity documentation more easily. So we did an experiment to see how it could work.)
In order to get an idea of what kind of feedback we can get from the community, we enabled a “Suggest a Change” function on the documentation site, directly on the page you want to comment on. The feature was enabled for the whole month of August and looked like this:
为了了解我们可以从社区中获得什么样的反馈,我们在文档站点上的您要评论的页面上直接启用了“建议更改”功能。 该功能已在整个8月启用,如下所示:
We wanted to see what kind of feedback we would receive and how we can best address it. During August, we got approx. 500 suggestions this way. These were the most common topics:
我们想看看我们将收到什么样的反馈以及如何最好地解决它。 在八月,我们得到了大约。 这样有500条建议。 这些是最常见的主题:
-
C# examples and conversion errors (~30%)
C#示例和转换错误(〜30%)
-
Suggestions, spelling corrections and open-ended queries on how to improve the docs (~30%)
有关如何改善文档的建议,拼写更正和开放式查询(〜30%)
-
Reports of missing links
缺少链接的报告
-
Feature requests
功能要求
-
Spam (~10%)
垃圾邮件(〜10%)
C#示例和消除转换错误 (C# examples and eliminating conversion errors)
The most common feedback we received related to missing C# examples in the Scripting API documentation. As you can see in the blog post on Unity’s scripting languages, we have kept an eye on stats for scripting language usage. Given that the majority of our users use C# and that our internal tooling support for for UnityScript lacked some features, we decided that for Unity 5 documentation:
我们收到的最常见反馈与Scripting API文档中缺少C#示例有关。 如您在有关Unity脚本语言的博客文章中所见,我们一直在关注脚本语言使用情况的统计信息。 鉴于大多数用户使用C#,并且我们对UnityScript的内部工具支持缺乏某些功能,因此我们决定使用Unity 5文档:
-
C# will be the default language internally for code samples in the documentation
C#是文档中内部代码示例的默认语言
-
We’ll develop a new C#-to-UnityScript converter, which preserves code-comments during conversion (another of the major complaints about our code samples) and solves other issues with the old converter.
我们将开发一个新的C#-UnityScript转换器,该转换器可以在转换过程中保留代码注释(这是有关代码示例的另一大抱怨),并解决了旧转换器的其他问题。
You will also notice that our Learn Team uses C# for the new Sample Assets, which will replace Standard Packages in Unity 5. We believe that moving to C#, combined with the new tooling support, will result in higher quality documentation. All we want is to provide you with valuable and useful code samples you can use in your projects.
您还将注意到,我们的学习团队将C#用于新的示例资产 ,它将替换Unity 5中的标准包。我们相信,迁移到C#并结合新的工具支持,将可以提高文档质量。 我们要做的就是为您提供可在项目中使用的有价值和有用的代码示例。
不再有断开的链接 (No more broken links)
For Unity 4.5 documentation, we introduced automated link-validation, although given the number of broken links (~100) for 4.5, it simply reports the broken links internally as part of the build. Our goal for Unity 5 is to reduce the number of broken internal links, and eventually drive that number down to zero, at which point we can have a process internally that makes sure broken links no longer get introduced by accident.
对于Unity 4.5文档,我们引入了自动链接验证,尽管给定4.5断开的链接数量(〜100),但它只是在内部将断开的链接报告为构建的一部分。 Unity 5的目标是减少内部链接断开的数量,并最终将该数量降低到零,这时我们可以在内部进行一个过程,以确保不会再偶然引入断开的链接。
未来 (The future)
The feedback we got from the one month trial of our “Suggest a change” feature was valuable and really showed us the huge interest there is in the community in helping to improve our documentation. Right now, we’re considering how to enable this in the future. We will most likely reintroduce the “Suggest a change” feature at a later point, in one form or another.
我们从“建议更改”功能的为期一个月的试用中获得的反馈非常有价值,并确实向我们显示了社区对帮助改进文档的巨大兴趣。 目前,我们正在考虑将来如何实现这一目标。 我们很可能会在以后以一种或另一种形式重新引入“建议更改”功能。
The Documentation and Infrastructure Teams
文档和基础架构团队
翻译自: https://blogs.unity3d.com/2014/11/12/improving-the-unity-5-documentation-based-on-your-feedback/
unity5离线文档下载