Unity官方文档团队向您问候！2016年是不可思议的一年，从文档本身到工作流程，我们做出了巨大的改变。下面我们一起来看看Unity官方文档团队的组建、文档开发、流程建立和后续计划，希望您可以感受到我们致力于让Unity官方文档更完善的想法与计划！

团队组建
团队规模在2016年快速增长。2015年12月，团队仅有3个人：2个具有编程背景和1个具有编辑背景的技术写手。但仅一年之后我们扩充到7人：1个项目经理，3个具有编程背景和2个具有编辑经验的技术写手，以及1个工具工程师。

文档开发
我们的文档开发在发布时间、用户指引和公测文档方面均有相应的改进。

文档内容与Unity版本同时发布
Unity版本发布日的Unity新功能和更新内容的文档增加了超过一倍：
2015年12月8日 Unity 5.3：在Unity 5.3发布日，我们发布了28个新的编辑器功能以及更新，并且在2016年5月追加了25个额外更新。 2016年11月30日Unity 5.5: 在Unity 5.5 发布日，我们发布了65个新的编辑器功能和更新。

更好更清晰的用户指引
在2016年，我们新增了以下内容：
在文档中新增了对应的Unity版本参考 新增了一个Unity问题链接，这样如果用户发现某个功能和文档中描述不符，可以通过它查看这个问题是否为已知问题 在用户手册的所有顶层菜单中，提供与用户信息源相关的重要链接 解释错误内容和含义的404页面 对用户手册的很多部分进行重新编排 将Unity服务文档纳入用户手册中 记录每个文档发布的版本 用户可以在用户手册中进行文档版本切换

Unity公测版文档
之前：Unity测试版仅对部分团队开放，并且同时仅有一个正式版，这意味着我们可以在整个测试阶段准备文档。

现在：测试版已全面公开，所以需要文档支持。虽然测试阶段可以改变功能，但我们没有时间在测试版发布前的编辑阶段，对不断变化的新功能进行更新。我们打算在Unity 5.6 beta版发布时尝试“Beta版测试文档”，以辅助编辑beta版的功能文档。

流程建立
开发流程的建立不仅仅是从无到有，更多的是具有标准化风格，突出所有权以及便于团队协同开发。


开发用户手册内容的标准流程
之前：没有技术写作和编辑流程。

现在：用户手册的所有内容都会通过多级技术协作和编辑流程来完成：
接收来自Unity开发者的信息 强调开发编辑，从阅读信息，到与开发者交流，了解到解释不清晰或者缺失的部分。我们的工作就是鼓励用户，所以总是尽可能多地提供信息，即使这些信息在有经验的编程人员看来是显而易见的 经过一系列的反复审核，开发者认同我们的修订之后，将文档移交给文档团队的另一位成员进行初次校对 文档以草稿页的形式被上传到CMS 文档再一次被不同的团队成员检查之后，才能最终批准发布

我们的流程保证了每一页被至少两个人校对，让它尽可能清晰地展现在用户面前。

Unity通用风格指南
之前：几乎没有标准术语和风格标准，文档中有大量不一致的内容。

现在：有了Unity的通用风格指南，保证了文档、教育、RD内容和支持方面编辑术语和风格的一致性。这个风格指南目前有超过250个实例。特别值得一提的是，它帮助我们保证了写在文档中和在编辑器中的对应内容一致，换句话说，用户文档和Unity部分，例如教育素材，和Knowledge Base中的内容是匹配的。例如：Inspector window (menu: Window > Inspector)总是被称作“the Inspector window”而不是the Inspector panel, 或者 the Inspector tab。

文档所有权
之前：没有技术写作和编辑流程，也没有文档的所有权。任何Unity的员工可以在文档中添加内容，用户可以实时看到这些未经查验或校对的内容。

现在：CMS已经升级，这样虽然Unity内部所有开发者依然可以更改文档，但是它们不能被发布，直到文档团队审阅后才可以。这帮助我们确保信息是清晰的，并且术语可以满足我们的标准。在Unity这样的公司里，因为开发人员说着不同的语言，所以保证清晰和一致是很重要的。

与所有创建文档的Unity团队协作
之前：团队之间的协调受限于资源。

现在：在设计和计划新流程时，我们保证所有的Unity内容生产团队（例如RD内容、教育、服务和支持）都可以被考虑进来，以传达一致的、清晰的文档给我们的用户。

2015年12月8日起，我们已经发布了31个在线文档版本，公开发布的版本也有多个（比如5.3、5.4和5.5b）。

后续计划
我们深知现有的文档是不完美的。每个Unity版本都有1200页用户手册和10000页脚本参考（API文档），比如Unity 5.3、5.4、5.5及5.6各有11200页。这些内容源可以追溯到很久以前，那时候Unity的规模还很小，文档也没有所有权，所以不可避免地有很多漏洞、错误、过时的信息和空脚本参考（API文档）页。

其实作出改进的主要障碍是我们现有的工具，这个工具很慢而且无法实现更为简单的编辑流程。这些工具来自Unity不同的时期，那时发布新版本频率较低且新功能数量较少。我们有计划来解决这个问题，虽然现在探讨更多的细节还为时过早，但我们会尽力让文档编辑更快、更流畅、更简单。


总结
总的来说，这是了不起的一年，我们希望2017年可以达到更多成就。我们非常感谢Unity社区的支持，社交媒体和社区论坛不断提醒着我们为什么要做这项工作。请继续关注，我们希望在新的一年为您带来更多惊喜！如果想要了解更多信息，请访问Unity官方平台。


原文链接：https://blogs.unity3d.com/2017/01/26/unity-documentation-in-2017/
转载请注明来源：Unity官方中文社区 (forum.china.unity3d.com)。请勿私自更改任何版权说明信息。
Unity文档, 更新

锐亚教育 锐亚科技 unity unity教程