つばろぐ

主に C#, .NET, Azure の備忘録です。たまに日記。

変更履歴フォーマットを解説する「Keep a Changelog」を日本語に翻訳した話

もう1年半以上まえの話になりますが、「Keep a Changelog」というサイトの日本語訳を作りました。
そういえばブログを書いていなかったなーとふと思い出したので、紹介がてら記事を書きます。

keepachangelog.com

GitHubのようなGitリポジトリで「CHANGELOG.md」というファイルを見かけたことがありますか?
このファイルではリポジトリに対する変更やリリースを時系列に記載して、どういった変更があったかを見易くする効果があります。

「Keep a Changelog」は、そのCHANGELOG.mdファイルにどういった情報をどういったフォーマットで書けばよいかを解説しているサイトになります。

なにかのきっかけで「Keep a Changelog」を読む機会があり、ただ日本語のドキュメントが無かったため翻訳してみました。
英語は苦手なので細かい部分はGoogle翻訳を使いながら、日本語化しました。(いまだとDeepLを使えばもうちょっと作業が楽だったのだろうか。)

Hamlというマークアップ言語でドキュメントファイルを作り、RubyでHTMLファイルに変換する手順になっています。

日本語用のドキュメントを作った後はプルリクエストを作り、無事にマージされました。

github.com

ライブラリを書くようなときがあれば、CHANGELOG.mdを作りたいと思っています。