💡

リリースノート書き方の注意点

2024/02/09に公開

リリースノートとは

Webアプリケーションなどのソフトウェア製品でリリースされた時に、
機能追加や不具合修正の内容などをユーザーやクライアントなどに示す資料やウェブサイトです。

これは開発者向きではなく、顧客に見せるもので、ITがわからない人にわかるように書かなければ
いけません。

専門用語やタスクの内容をそのまま書いたり、綺麗な書き方をしなければ、
お客様からの信頼が失ってしまいます。

どこの現場でも当てはまりそうなことを書いておきます。

1.誤字脱字に注意

2.文字や文言、型などを統一

3.文字の大きさを統一

4.ダブルチェックは必須

5.無駄な表現をカット

6.日付などの数字は0を使用(ex 2024/01/07)

7.修正点や改善点、結果のみにフォーカスして記載(ex 〇〇機能追加、〇〇修正、〇〇改修)

LINEのリリースノートです。これを参考にしてください。