STEPLP

仕様・API

仕様書インデックス

spec/ の一覧・読み順・依存関係。

Swipe LP 仕様書 — 索引・要約

目的: docs/spec/ および仕様と密接な関連文書の所在・役割・読む順を一箇所にまとめる。
正本の条文は各ファイル本体。矛盾した場合は 日付の新しい spec 本文と decisions/log.md を優先する。

1. 仕様の層（ざっくり）

層内容主な参照先
データ契約LPを表す単一JSON、イベント形、埋め込み/ZIPのファイル名・属性lp-definition-v0.1.md、analytics-events-v0.1.md、embed-and-zip-v0.1.md
公開ランタイム ↔ サーバ閲覧者向け GET/POST、計測キー形式api-v0.1.md
制作・運用（管理）Workspace/LP、メディア、仮公開、集計manage-api-v0.1.md
プロダクト全体MVPの範囲・目的・チーム・課金の置き場mvp.md
インフラ・リポジトリモノレポ、技術、rewrite、Compose の考え方stack.md
UI・体験の寄せ先競合型ナビとの対応、SPとクリエイティブのギャップproduct-ui-parity.md、creative-sp-pipeline-v0.md
将来・方針AI、スキーマ未載のテーマai-features.md

2. 文書一覧

文書位置づけ要約
mvp.mdMVPの全体像社内優先・外販に備えたマルチテナント。作成LPはSP向け。配信（埋め込み/ZIP）、LP定義の単一ソース、ステップ・CTA・ホットスポット、Workspace、分析必須イベント、認証抽象、課金はフィールドのみ、AIは別紙。競合型UIは product-ui-parity.md へ。
lp-definition-v0.1.md確定・スキーマルート（schemaVersion、id、revision、meta、swipe、steps）。ステップは image/video、cta、hotspots（正規化矩形）。step.id は公開後も不変。メディアは相対パスを正。
analytics-events-v0.1.md確定・計測共通エンベロープ、sessionId 匿名、バッチPOST。step_view 閾値（表示率・継続時間）、step_dwell、cta/hotspot、スワイプ、動画イベント。バッチ上限・MVPダッシュボード指標。
embed-and-zip-v0.1.md確定・配信埋め込み: runtime.js、data 属性、SwipeLP.mount、定義取得 URL。ZIP: index.html、lp.json、swipe-lp.runtime.v0.js、assets/、swipe-lp.config.json。プレビュー surface。
api-v0.1.md確定・公開APIGET /v1/public/lp/{lpId}、POST /v1/analytics/events、CORS、エラー形、計測キー `pk_{live
manage-api-v0.1.md確定・管理APIADMIN_TOKEN（X-Admin-Token / Bearer）。Workspace/LP CRUD、メディアアップロード、preview-share（仮公開トークン）、公開、計測キー発行、analytics/summary 等。
stack.md確定・基盤npm workspaces、apps/web・apps/api・packages/viewer、PostgreSQL、S3互換、rewrite。管理APIの一覧は manage-api-v0.1.md を正と明記。
product-ui-parity.md対応表・バックログ競合CMS型の「サイト制作／効果測定」との画面・用語の対応。データ正本は変えない。未実装（グリッド、POPUP CTA、ロゴ等）は切り分け。
creative-sp-pipeline-v0.md現状と段階的改善アップロード〜viewer の縦横比・object-fit: cover のギャップを明示。ガイドライン、編集時警告、将来の media.fit 等。
ai-features.md方針サーバ実行・ジョブ・ストレージ・プロバイダ抽象・監査。MVPコアとは切り分け。
ai-lp-image-jobs-v0.1.md確定・管理APILP 向け OpenAI gpt-image-2 画像ジョブ（生成・編集）。size_preset、ポーリング用 GET。
ai-writing-v0.1.md確定・管理APIAI 文案提案（同期）。CTA・メタ・ナレッジ・ステップ補足・ストーリーボード。

3. おすすめの読み順

  1. まず全体 … mvp.md
  2. LPが何か（データ） … lp-definition-v0.1.md
  3. どう配信するか … embed-and-zip-v0.1.md
  4. 公開APIとキー … api-v0.1.md
  5. イベントと集計 … analytics-events-v0.1.md → 管理の集計は manage-api-v0.1.md の analytics/summary
  6. 制作パイプライン … manage-api-v0.1.md（アップロード・仮公開含む）
  7. リポジトリとデプロイの前提 … stack.md
  8. 管理画面の言い回し・未実装の整理 … product-ui-parity.md
  9. SPと素材 … creative-sp-pipeline-v0.md
  10. AI … ai-features.md → ai-writing-v0.1.md / ai-lp-image-jobs-v0.1.md（必要時）

4. 依存関係（参照の矢印）

mvp.md
  ├→ lp-definition-v0.1.md
  ├→ embed-and-zip-v0.1.md ──→ api-v0.1.md
  ├→ analytics-events-v0.1.md ──→ api-v0.1.md
  ├→ manage-api-v0.1.md ──→ api-v0.1.md（プレビューURL 等）
  └→ product-ui-parity.md
stack.md ──→ manage-api-v0.1.md , api-v0.1.md
creative-sp-pipeline-v0.md ──→ lp-definition-v0.1.md

5. 関連（spec/ 外）

パス内容
../README.mdリポジトリ全体のドキュメント目次
../presentation/overview.mdプレゼン向けに圧縮した説明（仕様の正本ではない）
../decisions/log.md意思決定ログ
../deploy/nginx-proxy-sslip.mdDocker・プロキシ・sslip
../design/ui-guidelines-v0.md管理Webの見た目指針（フォント・色・レイアウト）

6. メンテナンス

  • 仕様を変えたら 当該 spec/*.md を更新し、decisions/log.md に1行追記（プロジェクトルール）。
  • 本 README.md は 索引なので、条文レベルの変更は各 spec にのみ書く。

ソース: docs/spec/README.md