chore: 문서 수정
This commit is contained in:
@@ -27,6 +27,20 @@
|
||||
|
||||
여기서는 `호출 주체가 다르다`를 구성요소 이름으로 바꾸는 데서 멈추지 않는다. 작성자가 같은 화면을 보고, 예상과 다른 요청을 발견하고, 낯선 값을 이해한 뒤, 각 구성요소를 확인한 순서로 문단 전체를 다시 쓴다.
|
||||
|
||||
## 작성자와 외부 분석자를 바꾸지 않는다
|
||||
|
||||
사용자가 자신이 만든 코드를 설명한다면 다음 문장은 관점이 잘못됐다.
|
||||
|
||||
수정 전:
|
||||
|
||||
> 처음 저장소를 열었을 때 19개 모듈이 먼저 보였습니다. 각 빌드 파일을 따라가 보니 코어의 클래스패스를 제한하는 구조였습니다.
|
||||
|
||||
수정 후:
|
||||
|
||||
> 코어에서 금지한 프레임워크 타입이 보이지 않게 하려고 클래스패스를 모듈마다 나눴습니다. 선택형 어댑터까지 분리한 결과 19개 모듈이 됐습니다.
|
||||
|
||||
작성자는 자신의 코드를 `열어 보고`, `훑어 보고`, `따라가며 발견한` 사람처럼 말하지 않는다. 만들 때 해결하려 한 문제, 정한 기준, 구현한 방법, 아직 연결하지 않은 범위와 받아들인 비용을 설명한다. 반대로 소유 관계를 알 수 없는 문서에 작성자 경험을 새로 붙이지 않는다.
|
||||
|
||||
## 한국어에서는 실제 차이를 바로 말한다
|
||||
|
||||
수정 전:
|
||||
@@ -57,7 +71,7 @@
|
||||
|
||||
수정 후:
|
||||
|
||||
> AP1과 AP2에서는 브라우저가 API를 직접 부른다. AP3에서는 BFF가 대신 호출하고, AP4에서는 Nginx가 요청을 이어 간다.
|
||||
> AP1과 AP2에서는 브라우저가 API를 직접 부릅니다. AP3에서는 BFF가 대신 호출하고, AP4에서는 Nginx가 요청을 이어 갑니다.
|
||||
|
||||
`호출 주체가 다르다`고 분류하지 말고 실제 구성요소와 행동을 쓴다.
|
||||
|
||||
@@ -69,7 +83,7 @@
|
||||
|
||||
수정 후:
|
||||
|
||||
> 그래서 패턴 이름만 보고 구현되지 않은 운영 속성을 덧붙이면 안 된다.
|
||||
> 그래서 패턴 이름만 보고 구현되지 않은 운영 속성을 덧붙이면 안 됩니다.
|
||||
|
||||
실제 순서를 뜻하지 않는 `첫 번째`, `두 번째`, `마지막`은 제거한다. 절차, 화면, 레이어처럼 순서 자체가 정보라면 유지한다.
|
||||
|
||||
@@ -81,7 +95,7 @@
|
||||
|
||||
수정 후:
|
||||
|
||||
> 브라우저가 Resource Server를 직접 부르는 방식은 유지해야 했다. 다만 client secret과 refresh token까지 JavaScript에 맡길 수는 없었다. 그래서 code 교환과 refresh token 보관은 confidential mediator가 맡았다.
|
||||
> 브라우저가 Resource Server를 직접 부르는 방식은 유지해야 했습니다. 다만 client secret과 refresh token까지 JavaScript에 맡길 수는 없었습니다. 그래서 code 교환과 refresh token 보관은 confidential mediator가 맡았습니다.
|
||||
|
||||
`상황`, `선택`, `대안`, `가드레일`을 주어로 삼지 않는다. 그 자리에 요구, 행동, 이유, 남은 비용을 넣는다.
|
||||
|
||||
@@ -89,9 +103,9 @@
|
||||
|
||||
용어를 삭제하거나 모두 번역하지 않는다. 처음 이해가 필요한 지점에서만 짧게 푼다.
|
||||
|
||||
> 포팅은 코드를 다른 언어로 옮겨 다시 만드는 일이다.
|
||||
> 포팅은 코드를 다른 언어로 옮겨 다시 만드는 일입니다.
|
||||
|
||||
> authorized client는 로그인한 사용자와 OAuth client에 연결된 token 묶음이다.
|
||||
> authorized client는 로그인한 사용자와 OAuth client에 연결된 token 묶음입니다.
|
||||
|
||||
뒤 문장에서 이미 행동으로 뜻이 드러나면 별도의 정의를 반복하지 않는다.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user