Merge pull request #13 from ASAP-Lettering/ASAP-000

ASAP-000 docs: 각 모듈에 대한 설명 추가

Author: tlarbals824

Application-Module/README.md

@@ -3,6 +3,7 @@
 ## 역할
 
 * `Lettering` 서비스의 핵심 비즈니스 로직을 처리한다.
+* 라이브러리는 Spring Stereotype을 사용하여 구현한다. 그 외의 라이브러리는 최소한으로 사용한다.
 
 
 ## 패키지 구조

Bootstrap-Module/README.md

@@ -4,6 +4,8 @@
 
 * RESTAPI를 제공하는 모듈
 * 프로그램의 기능을 사용하기 위한 시작점
+* API 스펙을 정의하고, 구현체를 제공
+* Spring Boot를 사용하여 구현
 
 ## 패키지 구조
 

Common-Module/README.md

@@ -0,0 +1,7 @@
+# Common 모듈
+
+## 역할
+
+
+## 패키지 구조
+

Domain-Module/README.md

@@ -0,0 +1,18 @@
+# Domain 모듈
+
+## 역할
+
+* Domain 모듈은 서비스에서 사용되는 도메인 모델들을 관리한다.
+* 외부 라이브러리나 프레임워크에 의존하지 않는다.
+
+## 패키지 구조
+
+```markdown
+.
+└── Domain-Module/
+    └── {domain}/
+        ├── entity
+        ├── enums
+        ├── vo
+        └── {service}
+```

Infrastructure-Module/Client/README.md

@@ -0,0 +1,12 @@
+# Client 모듈
+
+## 역할
+
+* Client 모듈은 Application 모듈과 Domain 모듈을 지원하는 역할을 한다.
+* 주로 Application 모듈에서의 port의 구현체를 제공한다.
+* Client 모듈은 외부 서비스(ex OAuth, ...)와의 연동을 담당한다.
+
+## 패키지 구조
+
+```markdown
+```

Infrastructure-Module/README.md

@@ -0,0 +1,18 @@
+# Infrastructure 모듈
+
+## 역할
+
+* Infrastructure 모듈은 Application 모듈과 Domain 모듈을 지원하는 역할을 한다.
+* 주로 Application 모듈에서의 port의 구현체를 제공한다.
+* Application 모듈에서 필요한 외부 라이브러리와의 연동을 담당한다.
+  * ex) db, security, http client, ...
+
+
+## 패키지 구조
+
+```markdown
+.
+└── Infrastructure-Module/
+    ├── Client
+    └── Security
+```

Infrastructure-Module/Security/README.md

@@ -0,0 +1,13 @@
+# Security 모듈
+
+## 역할
+
+* Security 모듈은 Application 모듈과 Domain 모듈을 지원하는 역할을 한다.
+* 주로 Application 모듈에서의 port의 구현체를 제공한다.
+* Application 모듈에서 필요한 보안 관련 기능을 담당한다.
+  * ex) 인증, 권한, 암호화, ...
+
+## 패키지 구조
+
+```markdown
+```

README.md

@@ -10,10 +10,28 @@
 
 ```markdown
 .
-├── app/
-│   └── domain/
-│       ├── api
-│       ├── controller
-│       └── dto
-└── core
+├── Application-Module/
+│   └── {domain}/
+│       ├── port/
+│       │   ├── in
+│       │   └── out
+│       ├── service
+│       ├── vo
+│       └── exception
+├── Bootstrap-Module/
+│   ├── {domain}/
+│   │   ├── api
+│   │   ├── controller
+│   │   └── dto
+│   └── common
+├── Common-Module
+├── Domain-Module/
+│   └── {domain}/
+│       ├── entity
+│       ├── enums
+│       ├── vo
+│       └── {service}
+└── Infrastructure-Module/
+    ├── Client
+    └── Security
 ```