関連タグで絞り込む (0)

  • 関連タグはありません

タグの絞り込みを解除

ドキュメントとリリースノートに関するcarpediem78のブックマーク (5)

  • リリースノートとは何か、何を書くのか - Markdownフォーマット付 - Qiita

    (翻訳) リリースノートとは、ソフトウェア製品やハードウェア製品と一緒に配布される文書のことで、製品がまだ開発やテストの状態(ベータリリースなど)のときに配布されることもある。 すでに顧客に使用されている製品の場合は、アップデートがリリースされたときにリリースノートが顧客に届けられる。また、リリースノートの別の略語として、Changelog or Release logs, Software changes, Revision history Updates あるいは README fileがある。 日語では リリースノートは、ソフトウェア製品の個別のリリースバージョンに関する 機能強化、仕様変更、不具合修正などを、エンドユーザーや製品購入者に対して提示することを目的とする。 リリースノートは個別のリリース内容について簡潔に記載されるものであって、仕様書やマニュアルの役割を担うものではな

    リリースノートとは何か、何を書くのか - Markdownフォーマット付 - Qiita
  • わかりやすくて役に立つリリースノートを書くための10のポイント

    リリースノートとは、ソフトウェアのリリース時に機能や目的などを知らせるための資料であり、ソフトウェアがアップデートされる場合も機能強化や不具合修正に関する情報をリリースノートとして公開します。リリースノートの中には優れたものもあれば悪いものもあるとのことで、「よいリリースノートを書くための10のポイント」について、ソフトウェア開発者のサイモン・ウィルソン氏がまとめています。 Writing better release notes https://simonwillison.net/2022/Jan/31/release-notes/ ウィルソン氏は、「リリースノートはオープンソースプロセスの重要な部分です」と述べ、GitHubなどでオープンソースのプロジェクトをリリースする場合、リリースノートを適切に書くことが大切だと主張しています。最近、「よいリリースノートの書き方」について考えていた

    わかりやすくて役に立つリリースノートを書くための10のポイント
  • リリースノート テンプレート(書き方とサンプル例)

    リリースノートとは ソフトウェアやWebサービスの場合、不定期にアップデートが行われることが一般的です。その際、何が変わったのか、どういった改善があったのかを明記するのがリリースノートになります。基的にはじめてリリースされる際には作成されず、更新時に変更ポイントをまとめた文書として作成されるのが一般的です。 リリースノートの目的 アプリストアやWebサービスの場合、過去バージョンの利用は基的にできません。そのためリリースノートを通じて変更点を把握することで、それまでできなかった新機能を知ったり、不具合が改善されたポイントを知ることができます。リリースノートがあることで、過去にどういった変更や修正が行われてきたかを確認できます。 オープンソース・ソフトウェアの場合、リリースノートにはどのPR(Pull Request)を取り込んだかもリストアップされます。それによってどの修正が取り込まれ

    リリースノート テンプレート(書き方とサンプル例)
  • noteのiOSアプリのリリースノートを書き続けて約1年が経つので振り返り|平野太一

    モバイルチームに誘ってもらい、noteのiOSアプリ(以下アプリと表記)のリリースノート作成を担当しています。ver 3.6.0(現在は ver 5.10.2)から担当し、その数もかなり多くなってきたので、自分がどういう意図を込めて書いてきたのか、振り返ってみようと思います。 リリースノートを担当するようになったきっかけ2020年5月のことでした。CXOの深津さんがSlackのリリースノートがいいとシェアしていて、それにのっかる感じで「大きいカイゼンのときはやってみたい」と手を挙げてみました。 ただ、当時の自分は何がすごいのか言語化できなかったので、自分もSlackのリリースノートを写経したことをきっかけに「UXライティング」という分野を知り、書籍や記事で学んだことをnoteにまとめて公開しました。 そのタイミングで、改めてモバイルチームから声をかけてもらったのです。 [余談] : 通常、

    noteのiOSアプリのリリースノートを書き続けて約1年が経つので振り返り|平野太一
  • ユーザーに素早く価値を届ける!アトラス流の社内リリースノートとは? | Atlas Developers Blog

    Confitだけでも月あたり5〜6回のリリースをしている計算になりますが、各リリースには大小さまざまな変更がいくつも含まれています。これは何らかの形で記録を残していかないと、何がいつ更新されたのか(または更新される予定なのか)わからなくなることが容易に想像できると思います。 アトラスサービスのセールス、サポートは、顧客である学協会や大会運営組織に対して、必ず担当者が付いています。特定のリリースにおいて、各担当者が「何が変更されたのか(何が変更される予定なのか)」、「どのタイミングでどの範囲のユーザーに影響があるのか」そういった内容を正確に把握し、必要に応じて顧客へアナウンスする必要があります。また、顧客から要望のあった機能を実現できるようになったり、困っていた不具合が解消されたり、そういった更新があれば、いち早く顧客へ伝えることができます。これらは、アトラスサービスをより活用いただくために

    ユーザーに素早く価値を届ける!アトラス流の社内リリースノートとは? | Atlas Developers Blog
  • 1