最初のバージョンのリリースノート
私は通常のリリースノートに何を含めるかを理解しています。それに関連する多くの質問と回答があります。
最初のリリースノート、つまり最初にリリースされたバージョンには何を含める必要がありますか？最初のバージョンにはリリースノートが必要ですか？
リリースノート（変更ログ）は主に、バージョン間の変更をユーザーに通知するために使用されます。おそらく、新しい便利な機能が利用できるか、古い機能が廃止されました。
最初にリリースされたバージョンに変更はありません。その場合、リリースノートは非常に単純です。
v1.0.0 2017-02-20
- ???? first release!
他のことは、私の経験では混乱するでしょう。
V1.0が最初のリリースではない場合もあります。これは、v0.xリリースが一般的であるオープンソースプロジェクトの場合に特に当てはまります。その場合、v1.0リリースには注意すべきいくつかの変更があります。少なくとも、v1.0リリースはAPIが安定していることを示しています。これは注目に値する変更です。
Webサイトまたはメーリングリストのリリースノートの場合、これらは技術的な変更ログではなく、プレスリリースのように記述する必要があります。最初のリリースは次の機会です。
- ソフトウェアが優れている理由を紹介し、
- 競合するソフトウェアとの違いを列挙し、
- 完全なドキュメントの概要を説明します。
変更ログがアプリケーションに埋め込まれている場合、最初のリリースでは、おそらくこのスペースに「はじめに」ガイドが表示されます。
リリースノートが後続のリビジョンにのみ表示される傾向があることは事実ですが、最初のリリースに同梱できなかった理由はありません。
最低でも、「初期リリース」のような日付、バージョン番号、説明が必要です。
最初のリリースが当初の目的ほど完全に機能していない可能性は十分にあります。ユーザーは、いくつかの機能を手に入れて、他の機能を待つことに熱心です。したがって、最初のリリースの内容と、後で使用できるように保留されている内容を説明できます。
また、テストでいくつかの問題を発見した可能性があります。これらの問題はリリースのリリースを止めるものではありませんが、ユーザーに知らせたい場合があります。これらは既知の問題ヘッダーなどにまとめられる傾向があります。
これが何のためにあるのか説明していませんが、ソフトウェアまたはハードウェアの要件もあるかもしれません。
リリースノートは簡潔な要約である必要があることに注意することが重要です。初期バージョンが複数のページで実行される場合は、単にユーザーにドキュメントを示すようにしたい場合があります。
通常、「新機能」のセクションを含めますか？
firstリリースでは、-everythingが新機能です。ほとんどをつくる;このセクションはneverはこの最初のセクションと同じくらい大きくなります。
ユーザーはすでにソフトウェアを購入またはダウンロードしているため、必要な機能が少なくとも1つありますが、提供する完全なリストeverythingの完全なリストをユーザーに提供しても害はありません。