diff --git a/doc/DOC.md b/doc/DOC.md index be792d4..151d985 100644 --- a/doc/DOC.md +++ b/doc/DOC.md @@ -1,8 +1,11 @@ # royleのプログラムについて -## 概要 +## パイプラインアーキテクチャの採用理由 + +このアプリケーションの目的は、データベース内の様々なデータをドキュメント化することだ。特定のテーブルやカラムの情報だけをドキュメント化するわけではない。パイプラインアーキテクチャーを採用した理由は、ターミナルのように複数のコマンドをつなぎ合わせて様々な表現ができる点を応用するためだ。これにより、様々なSQLやデータ成形関数、データ出力フォーマットを組み合わせることで、データベース内の多種多様なデータをドキュメント化できるようにしている。 -本プログラムはパイプラインアーキテクチャを採用している。主な流れは下のようになる。[統合テスト](https://github.com/digeon-inc/royle/blob/main/integration_test/integration_test.go)で実際の流れを見ればより具体的に理解できる。 +## 概要 +主な流れは下のようになる。[統合テスト](https://github.com/digeon-inc/royle/blob/main/integration_test/integration_test.go)で実際の流れを見ればより具体的に理解できる。 ```mermaid graph LR;