yutrutasu

📚 ドキュメント索引

このフォルダには、ゆるたすアプリケーションの開発に関する包括的なドキュメントが含まれています。

📂 ファイル一覧

🎯 specification.md

アプリケーション仕様書

プロジェクト概要
基本コンセプト
データモデル
機能詳細
技術仕様
ユーザーフロー

🏗️ architecture.md

アーキテクチャ設計書

レイヤーアーキテクチャ
コンポーネント設計
データフロー
状態管理パターン
拡張性の考慮
テスト戦略

🎨 design_guidelines.md

デザインガイドライン

カラーパレット
アイコン・絵文字システム
UIコンポーネント
タイポグラフィ
スペーシング
アニメーション

🔧 development_setup.md

開発環境セットアップガイド

前提条件
セットアップ手順
開発ツール設定
ビルド・デプロイ
デバッグ・トラブルシューティング

📋 読み方ガイド

🆕 新規開発者向け

specification.md - まずはアプリの全体像を把握
development_setup.md - 開発環境のセットアップ
architecture.md - コード構造の理解
design_guidelines.md - UI/UXの統一感を保つ

🔄 既存開発者向け

機能追加時: specification.md → architecture.md
UI修正時: design_guidelines.md
環境問題: development_setup.md

👥 プロジェクト管理者向け

要件定義: specification.md
技術選定: architecture.md
品質管理: design_guidelines.md

🔄 更新ルール

📝 ドキュメント更新のタイミング

機能追加・変更時: 該当ドキュメントを必ず更新
アーキテクチャ変更時: architecture.md の更新
デザイン変更時: design_guidelines.md の更新
環境・設定変更時: development_setup.md の更新

✅ 更新時のチェックリスト

変更内容が正確に反映されているか
他のドキュメントとの整合性は保たれているか
新規開発者が理解できる内容になっているか
図表・コードサンプルは最新の状態か

🤝 貢献ガイド

📝 ドキュメント改善提案

Issue作成: 改善提案をIssueで報告
Pull Request: 具体的な改善案を提出
レビュー: チームメンバーによるレビュー
マージ: 承認後のマージ

📋 書式ルール

Markdown: 基本的なMarkdown記法を使用
絵文字: 視認性向上のため適切に使用
コードブロック: 言語指定を明記
リンク: 相対パスでの内部リンク

🔗 関連リソース

📚 外部ドキュメント

🛠️ 開発ツール

📱 テスト・デプロイ

📧 質問・相談: プロジェクトの Issue や Discussion で気軽にお聞かせください。

🚀 Happy Coding! みんなで「ゆるたす」を育てていきましょう 🌱