コンテンツにスキップ

Jester Docs

Jester は odds park の記事自動生成プロジェクトのコードネームです。

このサイトは Jester プロジェクトの公式ドキュメントです。 プロダクトのビジネス仕様から開発・インフラの技術仕様まで、プロジェクトに関わるすべての情報をまとめています。


Jester の全体像

flowchart LR
    Race([レース情報<br/>結果・動画・予想]) --> ArticlePipe
    Race --> BlogPipe
    OldBlog([過去ブログ]) --> BlogPipe

    subgraph ArticlePipe[記事パイプライン]
        AG[article_generation<br/>10秒サマリーを執筆] --> AB[article_builder<br/>HTML を構築]
    end

    subgraph BlogPipe[ブログパイプライン]
        BG[blog_generation<br/>回顧・予想を書き下ろし] --> BB[blog_builder<br/>HTML を構築]
        BR[blog_rewriter<br/>過去ブログをリライト] --> BB
    end

    AB --> Draft([下書き])
    BB --> Draft
    Race --> TG[thumbnail_generation<br/>サムネイルを切り出し]
    TG --> Draft
    Draft --> Publish([担当者が公開])

ドキュメント構成

ビジネスドメイン

プロダクトの目的・登場人物・各機能のビジネスロジックを記載しています。 エンジニア以外の方はこちらをご覧ください。

ページ 内容
プロダクト Jester とは何か、解決する課題と主要機能
登場人物 システムに関わる人物・役割の一覧
記事生成 レース結果10秒サマリーの自動生成
ブログ生成 過去ブログのリライトと、レース回顧・予想の書き下ろし
サムネイル生成 レース動画からサムネイル画像を切り出す機能
Odds PoC コンテンツ管理アプリの機能一覧

アプリケーション

各 Lambda 関数・API・管理画面の技術仕様を記載しています。

共通

ページ 内容
Tech Stack 採用技術と選定理由
Coding Rule 実装規約
Directory Architecture リポジトリ構成と層の分け方
Shared Packages 共有パッケージ(エージェント・事実照合など)

Lambda

ページ 内容
article-generation レース結果10秒サマリーの生成
article-builder 記事 HTML の構築・保存
blog-generation レース回顧・予想ブログの書き下ろし
blog-rewriter 過去ブログのリライト
blog-builder ブログ HTML の構築・保存
thumbnail-generation レース動画からのサムネイル切り出し

odds-poc API

ページ 内容
Races レース情報・AI予想の管理 API
Articles 記事管理 API
Blogs ブログ管理・生成 API
Old Blogs 過去ブログ取り込み・リライト API
Categories カテゴリ管理 API
Medias メディア管理 API
NG Word NGワード管理 API
Ping ヘルスチェック API

フロントエンド

ページ 内容
user-web 管理画面(React SPA)の画面構成と使用 API

データベース

使用するデータベースとテーブル定義を記載しています。

ページ 内容
概要 テーブル一覧・共通ルール
article 記事テーブル
blog ブログテーブル
old_blog 過去ブログテーブル
category カテゴリテーブル
media メディアテーブル
ng_word NGワードテーブル
auto_racing オートレース情報テーブル
bicycle_racing 競輪情報テーブル
horse_racing 競馬情報テーブル

インフラ

AWS 上のシステム構成・サービス一覧・デプロイ方法を記載しています。

ページ 内容
インフラ構成 アーキテクチャ図・AWS サービス・Lambda / SQS / S3 一覧・デプロイ