Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 2.28 KB

File metadata and controls

45 lines (30 loc) · 2.28 KB

Ledgerly ドキュメント

Ledgerly の設計・開発・運用に関するドキュメントの目次です。 (プロジェクト概要は ルート README、開発ルールは CONTRIBUTING.md を参照)

🚀 はじめに(新規参画の方へ)

  1. onboarding.md — まずここから。 プロジェクト全体像と開発開始までの流れ
  2. guides/setup.md — ローカル開発環境のセットアップ手順
  3. ../CONTRIBUTING.md — ブランチ戦略・コミット規約・PR / レビューフロー

📁 ディレクトリ構成

フォルダ 内容
design/ 何を・どう作るかの設計(要件・アーキテクチャ・DB・セキュリティ)
guides/ 開発者向けの手順書(環境構築・外部サービス設定)
operations/ デプロイ・運用・SEO・トラブルシューティング
planning/ ロードマップ・進捗

🧭 設計 — design/

  • requirements.md — システム要件定義(目的・機能要件・業務フロー・集計ルール)
  • architecture.md — レイヤー構成・ディレクトリ構造・技術選定
  • database.md — テーブル定義・リレーション
  • security.md — 認証・認可・パスワード・レートリミット等

🛠 ガイド — guides/

  • setup.md — ローカル開発環境のセットアップ
  • google-oauth.md — Google OAuth クライアントの設定手順

🚢 運用 — operations/

  • deployment.md — Vercel への本番デプロイ手順
  • troubleshooting.md — 本番のマイグレーション / OAuth 障害の対処
  • seo.md — SEO 実装内容とチェックリスト

🗺 計画 — planning/

  • roadmap.md — フェーズ別の実装ロードマップと進捗

ドキュメントを追加・更新したら、この目次にもリンクを追加してください。