Skip to content

Commit

Permalink
docs フローチャート周り更新と整備
Browse files Browse the repository at this point in the history
  • Loading branch information
usuyuki committed Oct 19, 2022
1 parent 5e63575 commit 9bb97b7
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 24 deletions.
32 changes: 15 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@

## お使いになられる方へ

かどで日記は個人で振り返るサービスです。
整えて書くことを目的としている訳でなく、その時その時の感情を綴った日記を振り返りやすくする機能を中心に開発を進めています。
外部公開や共同編集などの機能は現在も今後も導入しません。
かどで日記は日記を振り返りやすくすることを目指して開発しているサービスです。
その時その時の感情を綴った日記を振り返りやすくする機能を中心に開発を進めています。

https://kadode.usuyuki.net

Expand Down Expand Up @@ -68,20 +67,19 @@ https://wiki.kado.day

```mermaid
flowchart TD
E_F[かどで日記v3.10]-->|ActionのUseCases分離|E_FF[かどで日記v3.11]
E_F-->|モデル名をpascalCaseに統一|E_FF
E_F-->|Diaryテーブルから自然言語処理データのカラムを分離|E_FF
E_F-->|Diaryテーブルから個々の日記のカラムを分離|E_FF
E_F-->|Userテーブルから通知既読カラムを分離|E_FF
E_FF-->|リレーション活用でDBの無駄なアクセスの削減|F[かどで日記v3.12]
E_FF-->|UseCasesの単体テスト整備|F
E_FF-->|Responderの整備|F
E_FF-->|FormRequestへの変更|F
E_FF-->|ブラウザテストで全体の動作のテストを作成する|F
F-->|Pythonの技術的負債の解体|G[かどで日記v3.13]
F-->|Pythonのコード責務分割|G
F-->|Pythonテスト導入|G
G-->|フロントエンド部分のリファクタリング|H[かどで日記v3.14]
311[かどで日記3.11]->312[かどで日記3.12]
311-->|同日日記の禁止|312
311-->|インポート機能の速度改善|312
311-->|infraディレクトリの整理|312
311-->|frontendの導入とdockerコンテナ名整理|312
312->313[かどで日記3.13]
312-->|array関数の除外|313
312-->|cs-fixerで無駄に重い処理を消し去る設定を強化する|313
312-->|意味のないダブルクォーテーションを消し去る|313
313->314[かどで日記3.14]
313-->|既存のバリデーションをFormRequestに置き換える|314
313-->|Responderの導入によりAPI側と旧blade側の両方で開発できるようにする|314
```

※「ブラウザテストで全体の動作のテストを作成する」は出先で Docker を構築して盛大に壊れたので一旦保留。ブラウザテスト環境を Docker で作る難易度が想像以上に高かった
Expand Down
3 changes: 2 additions & 1 deletion docs/ROADMAP/overall.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ flowchart TD
1-->|日記の基本機能整備|2[かどで日記v2.x]
2[かどで日記v2.x]-->|自然言語処理機能整備|3[かどで日記v3.x]
3-->|リファクタリング|4[かどで日記v4.x]
4-->|日記解析機能強化|5[かどで日記v5.x]
4-->|日記フロントエンドの分離|5[かどで日記v5.x]
5-->|日記自然言語処理の分離|6[かどで日記v6.x]
```
5 changes: 5 additions & 0 deletions docs/ROADMAP/v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,9 @@ flowchart TD
E-->|リポジトリ内の改行コード統一|E_F
E-->|Wikiのリポジトリ取り込み化|E_F
E-->|ADRアーキテクチャデシジョンレコードの導入|E_F
E_F[かどで日記v3.10]-->|ActionのUseCases分離|E_FF[かどで日記v3.11]
E_F-->|モデル名をpascalCaseに統一|E_FF
E_F-->|Diaryテーブルから自然言語処理データのカラムを分離|E_FF
E_F-->|Diaryテーブルから個々の日記のカラムを分離|E_FF
E_F-->|Userテーブルから通知既読カラムを分離|E_FF
```
12 changes: 6 additions & 6 deletions docs/ROADMAP/v4.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
```mermaid
flowchart TD
B[かどで日記v4.0]
B-->|類語付き検索機能|C[かどで日記v4.1]
C-->|ネガポジ判定精度改善|D[かどで日記v4.2]
D-->|統計生成の自動化|E[かどで日記v4.3]
D-->|インフラ大幅変更|E
E-->|閲覧アシスト機能|F[かどで日記v4.4]
40[かどで日記v4.0]
40-->|類語付き検索機能|41[かどで日記v4.1]
41-->|ネガポジ判定精度改善|42[かどで日記v4.2]
42-->|統計生成の自動化|43[かどで日記v4.3]
43-->|インフラ大幅変|44
45-->|閲覧アシスト機能|46[かどで日記v4.4]
```
9 changes: 9 additions & 0 deletions docs/ROADMAP/v5.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
```mermaid
flowchart TD
50[かどで日記v5.0]
50-->|類語付き検索機能|51[かどで日記v5.1]
51-->|ネガポジ判定精度改善|52[かどで日記v5.2]
52-->|統計生成の自動化|53[かどで日記v5.3]
52-->|インフラ大幅変更|53
53-->|閲覧アシスト機能|54[かどで日記v5.4]
```

0 comments on commit 9bb97b7

Please sign in to comment.