⭐️

【Polaris和訳】Content/App release notes

2021/10/29に公開約4,600字

この記事について

この記事は、Polaris/Content/App release notesの記事を和訳したものです。

記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

https://apps.shopify.com/shopify-application-314?locale=ja&from=daniel

Shopify アプリである、「らくらく日本語フォント設定|リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

https://apps.shopify.com/font-picker-1?locale=ja&from=daniel

アプリのリリースノート

マーチャントは、私たちのアプリで何が変わったのか、なぜ変わったのかをすぐに理解し、ビジネスの運営に戻ることが必要です。

マーチャントの「邪魔をしない」ために、機能的で信頼性が高く、使いやすいノートを書きましょう。

概要

アプリのリリースノートは

  • 役に立ち、情報を提供すること - 過度に技術的なことや宣伝にならないように、お客様が知る必要のある重要な情報に焦点を当ててください。
  • 端的でわかりやすい言葉を使うこと - 何が変わったのか、どのようなメリットがあるのかを、できるだけ効率的かつ明確に説明する。
  • リリースの規模を反映すること - 本当に重要なものであれば、人々に伝えること。
  • 具体的に説明しましょう - "Bug fixes and improvements "のような一般的な表現は使わないでください。問題を修正したり、何かをアップデートしたりした場合は、何を修正したのか、何をアップデートしたのかを伝えましょう。
  • 誰でもアクセスできるようにする - マーチャントには、さまざまな背景、場所、経験のレベルがあります。すべての人に私たちを理解してもらいたいのです。
  • 気の利いたことやおめでたいことは言わないようにしましょう - 私たちは人々の生活に影響を与える製品を作っています。たとえ彼らの成功に私たちが一役買ったとしても、それは私たちのことではありません。
  • 気の利いた言葉やユーモアは避け、常に聴衆の視点を第一に考えましょう - Shopify のブランドはユーモアがなく、ジョークは仕事に戻ることを妨げるものとして読まれる可能性があります。

Recognizably Shopify

それぞれの製品には個性があり、Android や iOS のアプリは POS や Shop とは異なります。Android や iOS のアプリは、POS や Shop とは異なりますが、それぞれが Shopify であることを示すものであり、私たちの原則やルールに従うものです。

ヒエラルキー

  • 重要度に応じてメモの優先順位を決める(最も重要なものから順に並べる
  • 重要なバグフィックスでない限り、アップデートから始める
  • 可能であれば、関連する修正やアップデートをまとめてください-Less is more
  • リリースの文字数制限は、Android では 500 文字、iOS では 4000 文字です。

書き方

  • アクティブボイスと過去形("We fixed "または "We updated")を使って、私たちが行った行動を説明する。
  • 完全なセンテンスを使う
  • マーチャントからのフィードバックに基づいて変更した場合や、修正が必要であるとの報告を受けた場合は、その旨を説明する。
  • プラットフォーム間(iOS、Android)で機能に差異がない場合、同じ言葉を使う

句読点

  • 箇条書きにする
  • 文章はピリオドで終わらせる
  • カンマ(,)は使用するが、セミコロン(;)、コロン(:)、感嘆符(!)、省略符(...)、疑問符(?)は使用しない。
  • エムダッシュ(-)を使うと、会話をしながら読みやすくなります。
  • 太字や斜体などのテキストフォーマットは使用しない。

文章のパターン

アップデートや変更を表現する方法はたくさんあります。何が変わったのか、なぜそれが重要なのかを、できるだけシンプルに説明できるパターンを選ぶようにしましょう。迷ったときは、つまらないほうがいいでしょう。

製品のアップデートや新機能について

新機能で何がどこで実現できるのか、具体的に説明してください。

  • {x}が使えるようになりました。
  • {x}ができるようになりました。
    • 注文画面からローカル配送の管理ができるようになりました。
  • 私たちは{x}を{y}にしました。
    • Shopify 全体で共通するアクションをより素早く行えるようにしました。iOS 13 以降でコンテキストメニューが使えるようになりました。
  • 私たちは{x}を更新しました。
    • サポート画面を更新して、読み込みが速くなりました。
  • x}を求められたので、{y}を追加しました。
  • お客様のフィードバックを聞き、それに基づいて{x}を変更しました。

解決済みのクラッシュまたはバグ

何が壊れていて、何が修正されたのかを具体的に説明してください。

  • 私たちは、{x}に関する問題を修正しました。
    • Face ID または Touch ID によるアプリのロック解除に影響するクラッシュを修正しました。
  • あなたは{x}ができませんでした。それを修正しました。
    • 割引の共有、編集、複製ができないことがありました。これを修正しました。(このパターンは控えめに使用し、重大な修正には使用しないでください)
  • 私たちは{x}の報告を受け、{y}の変更を行いました。

スタンドアロンでの更新

リリースの規模が大きく、多くのマーチャントに影響を与える場合は、アップデート内容を紹介した後、箇条書きでそれぞれの細かい部分を説明します。

Shopify のモバイルアプリでは、{x}を使って{y}を行うようになりました。

  • 特典 1
  • 特典 2
  • ベネフィット 3

一般的な更新

リリースは、一般的、汎用的なメッセージにならないよう、常に十分に具体的でなければなりません。

ノート構造

バグ修正が緊急でない限り、常にアップデートでリリースを開始してください。

複数回のアップデート

インラインヘッダーを使って、何がアップデートで何がバグフィックスかを示すなどしてください。

更新内容:スマートグリッドや注文ページからローカル配送の注文を確認して実行できるようになりました。

バグフィックス あるストアからログアウトして別のストアに入っても、アプリがクラッシュしなくなりました。

シングルアップデート

1 種類のリリース(アップデートやバグフィックス)を発表する場合は、1 つのヘッダーを使用します。例えば、以下のようになります。

バグフィックス。あるストアからログアウトして別のストアに入ると、アプリがクラッシュすることがなくなりました。

様々なアップデート

独立したアップデート、通常のアップデート、バグフィックスを示すために、インラインヘッダーとインデントを使用します。

例えば:

  • アップデート:Shopify モバイルアプリは Shopify ID を使用するようになりましたので、1 つのログインとパスワードで複数の Shopify アカウントにアクセスできます。

  • モバイルアプリで Shopify ストアを素早く切り替えることができます。
    再度ログインすることなく、Academy、Exchange Marketplace、Shopify Community、そしてパートナープログラムにアクセスできます。

アップデート:注文を編集する際に、同じ商品を複数回追加できるようになりました。

バグ修正。1 つのストアから別のストアへのスワップで、アプリがクラッシュすることはなくなりました。

リリースノートの例

日常的な修正や更新の場合は、何が変わったのかをわかりやすく明示してください。

インフラの更新については、マーチャントの利益を説明する。

技術的なアップデートについては、具体的に、しかしシンプルな表現を心がけてください。

ユーモアは避けましょう。

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

https://apps.shopify.com/shopify-application-314?locale=ja&from=daniel

Shopify アプリである、「らくらく日本語フォント設定|リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

https://apps.shopify.com/font-picker-1?locale=ja&from=daniel

Discussion

ログインするとコメントできます