Skip to main content

Discount Deck: 新しいお客様アカウント向けマニュアル更新

完了条件

  1. 以下2ページが、アプリの実コード(discount-deckextensions/customer-account-coupon-list / customer-account-coupon-page / packages/shared)と一致した記述になっている。
    • /apps/discount-deck/notice-customer-account-migration
    • /apps/discount-deck/setup/new-customer-accounts
  2. 2ページそれぞれに、コードから読み取れる仕様を根拠にした「よくある質問」が載っている。
  3. 日本語と英語の両方が更新され、mint broken-links が通る。

前提

  • 独立ページ(フルページ拡張)は discount-deck PR #351 の内容で、まだ本番リリースされていない。 この docs 変更のマージは #351 のリリース後に行う。
  • 公開は main マージ時。作業は docs/discount-deck-customer-account-fullpage ブランチで行い、main には直接反映しない。

タスク

  • 対象2ページの現状を読む
  • 拡張の設定スキーマ(toml)・ロケール・コンポーネントの挙動を確認する
  • 管理画面側のラベル(推奨画像サイズ・備考)を main で確認する
  • notice-customer-account-migration.mdx(日本語)を更新
  • setup/new-customer-accounts.mdx(日本語)を更新
  • 英語版2ページを同内容で更新
  • mint broken-links で検証
  • レビューセクションを書く

記述の根拠(コード)

レビュー

やったこと

検証

  • mint broken-linksno broken links found
  • mint dev で4ページとも HTTP 200、MDX のコンパイルエラーなし
  • 表・<AccordionGroup>`{{count}}` のコードスパンが意図どおり描画されることをレンダリング結果で確認

残課題

  1. マージは discount-deck PR #351 のリリース後。専用ページ表示は未リリースのため、先にマージすると存在しない機能の手順が公開される。
  2. 専用ページ追加手順のスクリーンショットがない。既存の new-customer-accounts-2.jpg はプロフィールページのエディタ画面。「ページを追加」の画面を撮って差し込みたい。
  3. faq/coupons-not-displayed との重複。メタフィールド権限の話を setup ページの FAQ に書いたため、既存 FAQ ページからの導線を足すか、内容を寄せるか要判断。
  4. ブロック表示の備考テキストがモーダル内にしか出ないCouponListComponent.tsx)。設定の説明文「クーポン一覧の下に表示される注記です」と挙動が食い違う。ドキュメントには実際の挙動を書いたが、アプリ側の修正候補。
  5. tools/channel-talk-migration/convert.py を再実行すると、この2ページはチャネルトークの元記事から再生成されて上書きされる。移行は完了しているため通常は実行しないが、実行する場合は注意。

追記(stg での実機確認)

stg(dd-auto-display-stg)のエディタとお客様画面で確認し、手順の誤りを1件修正した。

修正した誤り

追加の入口は「ページを追加」ではなく、エディタ左上の「アプリ」アイコン。 ここに Discount Deck の項目が並び、各行の「+」で追加する。専用ページは「+」を押すと 「ページの追加先」が出るので「アカウント」を選ぶ。ブロックも同じ一覧から追加する。 当初は Extension の README を根拠に「ページを追加」と書いていたが、実機に その導線は無かった。ページ切り替えのドロップダウンにも、追加済みページの「…」 メニュー(URLをコピー / 削除)にも無い。

新しく分かったこと

  • アプリ一覧には「保有クーポン一覧を表示」も並ぶ。これはチェックアウト用の別Extension
  • 削除して追加し直すと、設定値は引き継がれない(新しいインスタンスになる)。FAQ に追記した
  • エディタの変更は保存するまで反映されない。削除も「保存」を押さなければ元に戻せる

追加した画像

撮影はビューポートのみ(ブラウザのタブ・ブックマークを含まない)。既存画像と同じ 幅1600px・JPEG品質90に揃えている。

stg の状態

削除 → 追加画面の撮影 → 元に戻す、まで行った。保存は一度も押していない。 未保存の変更を破棄して再読み込みし、元の設定(備考テキスト・ボタンのレイアウト Secondary・画像の表示 Show)が戻っていること、お客様側のページが表示されることを確認済み。

追記(メニューに追加の導線)

専用ページを追加してもヘッダーメニューに項目が出ない場合がある。エディタで専用ページを 開くと、左パネルに案内が出る。
お客様がこのページにアクセスできるようにするには、ストアのデフォルト用の新しいメニューを 作成するか、このページを既存のメニューに追加してください。 [メニューを作成][メニューに追加]
「メニューに追加」を押すと、お客様アカウントのメニュー(customer-account-main-menu)の 編集画面が開き、「お持ちのクーポン一覧」の行が追加された状態になる。「名前」を変更して チェックマークで確定し、「保存」を押すと反映される。 この「名前」がメニューに並ぶ文言で、設定パネルの「ページタイトル」(ページ内の見出し) とは別物。FAQ の「項目名を変えたい」もこの画面を案内するよう書き換えた。 新しいメニューを作成 の場合は「メニューを作成」を押す。

stg の復旧

作業中に stg のメニュー項目が消えていたため、この導線で復旧した。 お客様画面で Orders / Profile / お持ちのクーポン一覧 が並ぶことを確認済み。 この復旧のためにメニューの「保存」を1回押している。(それ以外の保存はしていない)