docs: '구체적으로 쓰기' 페이지에 원칙 추가 #28
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
docs/sentence/concreteness.mdx
Outdated
| </DoDont.Do> | ||
| </DoDont> | ||
|
|
||
| ### ✅ 주어,목적어 같은 문장성분을 모두 써주세요. |
There was a problem hiding this comment.
문장성분 < 이라는 단어가 필요할까요?!
There was a problem hiding this comment.
주어 목적어 외에 '어디에' '어떻게'를 알려주는 부사어나 관형어도 써주면 좋을 것 같아서 문장성분이라고 넣었는데 위클리에서 얘기 나눠보면 좋을 것 같습니다!
|
|
||
| ### ✅ 구체적인 수치나 기준을 제시하세요. | ||
|
|
||
| '값', '설정', '성능' 같은 단어나 '많을 때', '빠르게' 같은 표현은 문맥에 따라 다르게 해석될 수 있어요. 맥락 없이도 단어가 가리키는 내용을 이해할 수 있게 구체적인 수치와 기준을 사용하세요. |
docs/sentence/concreteness.mdx
Outdated
| </DoDont.Dont> | ||
| <DoDont.Do> | ||
|
|
||
| 데이터가 10,000건을 초과하면 응답 시간이 1초 이상 소요됩니다. |
There was a problem hiding this comment.
nit) 초과, 소요도 조금 더 순화가 가능할까요?
There was a problem hiding this comment.
데이터가 10,000건을 넘으면 응답 시간이 1초 이상 걸립니다.
요렇게 수정해봤습니다
docs/sentence/concreteness.mdx
Outdated
|
|
||
| ### ✅ 문서 사이에서 참조되는 맥락을 설명하세요. | ||
|
|
||
| 뒤에서 사용할 내용을 앞에서 언급할 때는, 뒤에서 사용할 것이라고 명확하게 알려주세요. 반대로, 앞에서 언급한 내용을 뒤에서 사용할 때도 앞에서 언급했다고 명시하세요. 독자가 왜 이 정보를 지금 보는지, 나중에 어떻게 사용되는지 이해할 수 있어야 해요. |
There was a problem hiding this comment.
뒤에서 사용할 내용 < 이라는 게 더 구체적으로 나오면 좋을 거 같아요.
제목에서도 문서 사이가 아니라 문서 안에서도 적용될 수 있는 내용 같아요
There was a problem hiding this comment.
앵커가 있을 경우에는 참조되는 맥락을 설명하기 위해서 앵커 링크를 첨부하기도 하는 것 같아요. 이것까지 추가하기에는 과할까요?!
There was a problem hiding this comment.
| 뒤에서 사용할 내용을 앞에서 언급할 때는, 뒤에서 사용할 것이라고 명확하게 알려주세요. 반대로, 앞에서 언급한 내용을 뒤에서 사용할 때도 앞에서 언급했다고 명시하세요. 독자가 왜 이 정보를 지금 보는지, 나중에 어떻게 사용되는지 이해할 수 있어야 해요. | |
| 다른 문서나 단락에서 언급한 변수, 설정값, 개념 등을 다시 사용할 때는, 어디에서 설명했는지 알려주세요. 반대로, 다른 문서나 단락에서 사용할 정보를 처음 언급할 때도 어디에서 사용하는지 알려주세요. 참조되는 부분을 링크를 통해 알려줄 수도 있어요. 독자가 왜 이 정보를 지금 보는지, 나중에 어떻게 사용되는지 이해할 수 있어야 해요. | |
이렇게 수정해봤습니다 ㅎㅎ
docs/sentence/concreteness.mdx
Outdated
|
|
||
| 3. `apiKey`로 API 인증을 수행합니다. | ||
|
|
||
| - 1단계에서는 `apiKey`를 어디에 사용할지 알 수 없어요. 3단계에서는 `apiKey`의 출처가 명확하지 않아요. |
There was a problem hiding this comment.
| - 1단계에서는 `apiKey`를 어디에 사용할지 알 수 없어요. 3단계에서는 `apiKey`의 출처가 명확하지 않아요. | |
| - 1단계에서는 `apiKey`를 어디에 사용할지 알 수 없어요. 3단계에서는 `apiKey` 값을 어디서 얻었는지 확인하기 위해 문서의 앞 부분을 다시 읽어야 해요. |
There was a problem hiding this comment.
좀 더 읽는 사람 관점에서 써주면 좋을 것 같아요.
docs/sentence/concreteness.mdx
Outdated
| </DoDont.Dont> | ||
| <DoDont.Do> | ||
|
|
||
| 1. API 키를 생성하고 `apiKey` 변수에 저장합니다. 이 키는 다음 단계에서 인증에 사용됩니다. |
There was a problem hiding this comment.
다음 단계가 아니라 3단계, 혹은 아래 예시와 같이 ㅇㅇㅇ 할 때라고 명확하게 써주는 게 좋은 예시일 것 같습니다.
마찬가지로 아래도 1단계라고 명시하거나 링크를 다는 방식 등을 제안하는 게 좋을 거 같아요.
There was a problem hiding this comment.
| 1. API 키를 생성하고 `apiKey` 변수에 저장합니다. 이 키는 다음 단계에서 인증에 사용됩니다. | |
| 1. API 키를 생성하고 `apiKey` 변수에 저장합니다. 이 키는 3단계(3단계 링크)에서 API키 인증에 사용됩니다. | |
| ... | |
| 3. 1단계(1단계 링크)에서 `apiKey`에 저장한 API키로 인증합니다. |
이렇게 수정해봤습니다
| ::: details 정답 확인 | ||
|
|
||
| > 1. 환경 변수 설정하기 | ||
| > `DB_HOST`와 `DB_PORT` 값을 지정하세요. 이 값들은 데이터베이스 연결에 사용됩니다. |
brassjin
force-pushed
the
update-docs/concreteness
branch
from
24ef31f to
8f4ae72
Compare
수정한 내용
'구체적으로 쓰기' 페이지에 원칙 추가
이 변경이 필요한 이유 (선택)
TW 코멘트 수집 과정에서 나온 새로운 원칙을 추가했어요.
체크리스트