読者です 読者をやめる 読者になる 読者になる

若き JavaScripter の悩み

何かをdisっているときは、たいていツンデレですので大目に見てやってください。愛です。

Nodeの認証モジュール「Passport」の解説ページを邦訳しました

Nodeの代表的な認証モジュール「Passport」の解説ページを(勉強ついでに)邦訳しました(邦訳版ページ)。

Passportの解説ページ邦訳版のスクリーンショット

対訳機能はじめました

@merborne さんのエントリ「英語圏のオープンソースプロジェクトにおける翻訳ドキュメントの問題点とその解決のための一方策」に触発されて対訳機能をつけてみました。パラグラフの末にある» 原文 を押すと、対訳が下に表示されます(下図)。

f:id:devorgachem:20140324010128p:plain

また、markdown中に原文を<blockquote class="original">で囲って隠しているので、原文とのdiff も大変みやすく便利です。

このような対訳機能をつける必要性を先のエントリから引用すると:

原文と訳文のセンテンスごとの対応関係が明確になり、メンテナンス性が上がる。 オリジナルドキュメントと翻訳ドキュメント内の原文との差分を見ることで、翻訳文が読めなくても、翻訳ドキュメントがオリジナルの更新に追随しているかがわかる。 翻訳ドキュメントの利用者が容易に原文を確認できる一方で、その原文は非表示にできるので邪魔にならない。 —英語圏のオープンソースプロジェクトにおける翻訳ドキュメントの問題点とその解決のための一方策 - @merborne

過去にいくつかの仕様・解説を邦訳してきた経験から、どれもメリットを強く実感できる内容です。 これから邦訳をするひとは、対訳機能ぜひお試しを!

邦訳が終わって

この解説ページを読むまでは、「解説よりもAPIドキュメントが欲しかった…」なんて不届きなことを考えておりましたが、邦訳が終わってみると必要十分なドキュメントであったことがわかりました。

また、技術的な妥当性の確認のためにpassportのコードも読んだのですが、設計方針が単純明快ですっきりしていて好印象でした。また、バージョンも安定しているので安心して使うことができると思います。

謝辞

邦訳作業は @eemon18 氏と協力しておこないました。 また、技術的なアドバイス@ritouさんからいただきました。この2人の協力無くして邦訳は出来なかったと思います。ありがとうございました!