OmniGroup流のわかりやすい「リリースノート」の書き方

Pexels photo 373076

ソフトウェアの新バージョンが公開された際、ストアや公式サイトでは変更点を説明する「リリースノート」が公開されます。

新バージョンの新機能や変更点を知ることができる重要な情報ですが、開発者の方の中にはリリースノートをどうやって分かりやすく書けばよいのか頭を悩ませている方も多いかもしれません。

OmniFocusやOmniOutlinerなどMac/iOS用の生産性向上ツールで有名なOmniGroupが、自社でどのようにリリースノートを作成しているのか、その手順を説明する文書「How We Do Release Notes」を公開しています。

OmniGroup流リリースノートの書き方

OmniGroupでは以下の手順に従ってリリースノートを作成sているそうです。

記録を集める: プロダクトマネジャー(PM)がバグ追跡システム(ここではOmniBugZapper)を使用して、バグフィックスや新機能、変更点の記録を収集する。TestFlight中はSCMのログを使用する(svn log -r <revision of last release notes edit>:HEAD | less)ことで進行中の作業の記録を集めやすくなる場合もある。特定のリリースで何が変更されたのか正確に知るための作業が簡単であることが重要。

ノートを書く: MarkdownからHTMLに変換し、トークンを置き換える作業を行う。例えば:

- new - **Tags** --- Contexts have been replaced with Tags.

これが以下のようになる。

Rendered release note line

OmniGroupではTextMateやBBEditを使用し編集を簡単化している。

ノートの編集: 内部編集者メーリングリストでリリースノートが基準に合致することを確認する。編集者は常にフィードバックを行うわけではないが(了解のサムアップだけの場合もあり)、単語の提案や、不明確な点の確認、タイポの指摘などが行われる。OmniGroupではApple style guideを採用している。

ノートの公開: リリースノートは各アプリケーションに付属し、Macの場合は「ヘルプ > リリースノート」を選択して最新の情報を表示できる。この場合Webビューで表示される。Apple StoreのリリースノートはプレインテキストであるためHTMLをテキストに変換する。翻訳行い、アプリが公開されるとMacアプリの場合はWebサイトでも公開される。ブログやソーシャルメディアで公開される場合もある。

まとめ

OmniGroupのように大規模なソフトウェア製品を開発している企業の場合、リリースノートの作成も手順化されていることがわかります。企業ではなく個人開発者の方も自分なりの手順を定めておくと、リリースノートの作成を無駄なく行うことができるようになりそうです。

スポンサーリンク