2014年11月19日 星期三

與開發者共同完善Unity文件

作者:ALEKSANDR原文連結

我們知道許多開發者都希望能簡單反映Unity文件的建議,所以我們做了個實驗來看看它是否可行。

為了讓我們能從社群得到回饋,我們八月的時候在官方手冊頁面增加了“Suggest a Change”功能。頁面如下:



我們想看看我們能收到一些什麼樣的反饋以及如何用最好的方式來解決它。整個八月期間我們收到了大約500條建議。下面是一些常見主題:

· C#範例及轉換錯誤(約30%)
· 建議、拼寫糾正以及開放的詢問如何改進文檔(約30%)
· 連結失效報告
· 功能需求
· 垃圾信息(約10%)

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”功能。

沒有留言:

張貼留言

著作人