TSUNAGU-Link ドキュメント
このドキュメントは、TSUNAGU-Link の仕様・構成を整理するための mdBook です。
以下の章で構成されています。
- 概要
- アプリ仕様
- フロントエンド構成
- バックエンド構成
- インフラ構成
概要
TSUNAGU-Link は、社内向けに開発された内製プロダクトです。
この章では、プロダクトの目的、利用対象、提供価値を整理します。
サンプル記載項目
- 目的: 業務上の情報連携を効率化する
- 対象ユーザー: 社内メンバー
- 提供価値: 情報共有の一元化と検索性向上
アプリ仕様
この章では、TSUNAGU-Link の機能要件・画面要件・非機能要件を定義します。
サンプル記載項目
- 機能要件: ユーザー管理、検索、通知
- 画面要件: ダッシュボード、詳細画面、設定画面
- 非機能要件: 可用性、性能、監査ログ
フロントエンド構成
この章では、フロントエンドの技術選定、ディレクトリ構成、設計方針を記載します。
サンプル記載項目
- 技術スタック: React / TypeScript
- 状態管理: Zustand または Redux Toolkit
- UI方針: コンポーネント再利用とデザインシステム準拠
バックエンド構成
この章では、バックエンドのアーキテクチャ、API設計、データ設計を記載します。
サンプル記載項目
- 技術スタック: Node.js / Go / Java(プロジェクトに応じて選定)
- API設計: REST または GraphQL
- データ設計: RDB中心、必要に応じてキャッシュ導入
インフラ構成
この章では、インフラ全体像、デプロイ構成、監視・運用方針を記載します。
サンプル記載項目
- 実行基盤: Docker / Kubernetes
- デプロイ: CI/CD 連携で自動デプロイ
- 監視: メトリクス、ログ、アラートの整備