第一次在這裡發文。先說一下我的身分,免得被當成來打廣告的:我是 LibreDB Studio 的維護者之一,MIT 授權的開源工具。今天要問的事跟工具本身沒什麼關係,是我們內部吵很久、到現在還沒定案的一件事:多語系的 README 到底要做到什麼程度。
我們的 README 有六份。英文那份最完整,一千多行;其他五份(簡體中文、日文、西班牙文、烏爾都語、印地語)都是精簡版,三百行上下,只寫「這東西是幹嘛的」跟「怎麼裝起來」,再深入的就直接連回英文版。
先自首一件事:沒有繁體中文版。這也是我想順便問的。
前陣子有個第一次發 PR 的人,把簡中那份整個重寫,從 315 行補到 1014 行,照著英文版一節一節翻下來。老實說翻得不錯,我也不太想退。但收下去之後,簡中就跟其他四種語言不同調了,接下來要不要比照辦理,我們就卡住了。
兩邊的理由我們自己都講得出來。
全翻的好處很明顯,讀者不管用哪個語言,看到的東西都一樣。問題是英文那邊改一次,一千多行要誰去跟上?我們沒有專門做在地化的人,真的跟不上的話,最後就是一份看起來很齊、其實停在半年前的文件,那還不如一開始就請人直接看英文。
維持精簡的好處是不容易過時,壞處是讀者一路看下去,看到一半被丟去英文版,體驗其實滿差的。
所以想問一下平常也會看中文 README 的人:
你點開一個專案的中文 README,比較希望它內容齊全,還是寧可它短一點、但至少是對的?如果你發現它比英文版舊了半年,你會自己翻回英文看,還是心裡就先對這個專案打個折?
還有繁中這塊:你們會希望有獨立一份,還是簡轉繁就夠用了?
我們在 issue 那邊也在討論這題,想看實際情況的話在這裡:
https://github.com/libredb/libredb-studio/issues/1055
请查看这个翻译相关的 PR。 https://github.com/libredb/libredb-studio/pull/1052
我單純說自己的偏好,沒有說一定正確:其實我不喜歡多語言 readme
我覺得 readme 應該以英文,或是主要使用者會用的語言為主 (比如你預期你的專案是中文圈的人會用,那就用中文) ,理由其實就是寫 code 的人不一定會翻譯,如果要維護多份其實沒有能力審查 ,叫 AI 翻也行啦,只是你也只能相信 AI 翻的正確了
我覺得 readme 應該是給來看 code 的人看的,不是給來使用的人看的,你完全可以在 readme 上加上多語言的連結,把這些使用者全部導到網頁版的文件去,然後做多語言版的文件,你可能會想這有什麼不同,但我覺得不一樣,網頁簡單的你可以另外開一個 repo 放網頁版的文件,然後讓使用者來貢獻翻譯,或是用像 Crowdin 那樣的社群翻譯的工具,用工具翻譯有好處,你的原文改了 Crowdin 上就會被標記成過時的內容,必要時可以逐頁 fallback 回英文版