"시각적으로 구분하기" 섹션 생성, 문서 개선 #30
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
docs/visualization/callout.mdx
Outdated
| - 제목: 마이그레이션 전에 반드시 데이터를 백업해야 합니다. | ||
| - 본문: 스키마가 변경되면 기존 데이터가 손실될 수 있습니다. |
There was a problem hiding this comment.
콜아웃으로 감싸고 싶었지만, 이미 details로 감싸두어서 이렇게 작성했어요.
docs/visualization/callout.mdx
Outdated
|
|
||
| ### ✅ 콜아웃 사용 목적에 따라 색상을 구분하세요 | ||
|
|
||
| 콜아웃의 색상은 정보의 성격을 구분하는 데 사용해요. 색상을 나누면 독자가 어떤 내용을 보고 있는지 더 쉽게 판단할 수 있어요. 이 문서에서는 부가 정보는 파란색, 팁은 초록색, 주의가 필요한 내용은 노란색, 위험도가 높은 정보는 빨간색으로 구분해요. |
There was a problem hiding this comment.
소리 내어 읽을 때는 "이 문서에서는 / 부가 정보는 파란색 / 팁은 초록색 / ... " 이렇게 읽혀서 자연스러운데, 글로 작성하니 "는"이 반복적으로 나와서 어색해 보여요. 더 괜찮게 작성하는 방식이 떠오르지 않는데, 더 좋은 표현 방식이 있을까요? (gpt도 이상하게 추천하네요 ㅠ)
There was a problem hiding this comment.
이 문서에서 < 로만 해도 괜찮을 거 같아요 ㅎㅎ
There was a problem hiding this comment.
이 부분 수정하면서 지난번 동진님이 남겨주셨던 피드백 반영해서 콜아웃 종류를 더 구체적으로 작성했어요 @brassjin
docs: 콜아웃 종류 구체적으로 설명
docs/visualization/callout.mdx
Outdated
|
|
||
|
|
||
| ::: info 콜아웃의 제목에는 마침표를 붙이지 않아요 | ||
| 일반적으로 모든 종류의 제목에는 마침표를 붙이지 않아요. 콜아웃의 제목도 마찬가지예요. 마침표는 문장의 끝을 나타내는데, 제목 끝에 마침표가 있으면 내용이 끝난 것처럼 느껴져 시각적으로 답답해 보이고 자연스럽지 않기 때문이에요. |
docs/visualization/callout.mdx
Outdated
|
|
||
| import { DoDont } from '@/components/DoDont/DoDont'; | ||
|
|
||
| 콜아웃은 독자의 시선을 강하게 끌어서 놓치기 쉬운 중요한 내용을 전달할 때 사용해요. 문서 전체에서 강조해야 하는 정보나 주의해야 하는 사항을 시각적으로 구분해서 독자가 자연스럽게 읽도록 해요. |
There was a problem hiding this comment.
"읽도록 해요"라는 어미가 조금 어색한 거 같습니다
There was a problem hiding this comment.
다음과 같이 제안합니다.
| 콜아웃은 독자의 시선을 강하게 끌어서 놓치기 쉬운 중요한 내용을 전달할 때 사용해요. 문서 전체에서 강조해야 하는 정보나 주의해야 하는 사항을 시각적으로 구분해서 독자가 자연스럽게 읽도록 해요. | |
| 콜아웃은 독자의 시선을 강하게 끌어서 놓치기 쉬운 중요한 내용을 전달할 때 사용해요. 문서 전체에서 강조해야 하는 정보나 주의해야 하는 사항을 시각적으로 구분해서 독자가 자연스럽게 읽게 해요. |
docs/visualization/callout.mdx
Outdated
| import { DoDont } from '@/components/DoDont/DoDont'; | ||
|
|
||
| 콜아웃은 독자의 시선을 강하게 끌어서 놓치기 쉬운 중요한 내용을 전달할 때 사용해요. 문서 전체에서 강조해야 하는 정보나 주의해야 하는 사항을 시각적으로 구분해서 독자가 자연스럽게 읽도록 해요. | ||
| 특히, 본문 안에 섞여 있으면 지나칠 수 있는 정보도 콜아웃을 사용하면 독자가 쉽게 인지할 수 있어요. |
There was a problem hiding this comment.
👍
이게 먼저 나오면 어때요? 이게 콜아웃의 가치 같아서요! 가치 다음 기능(위에 있는 설명)이 나오면 좋을 것 같네유
| 마침표는 문장의 끝을 나타내는데, 제목 끝에 마침표가 있으면 내용이 끝난 것처럼 느껴져 시각적으로 답답해 보이고 자연스럽지 않기 때문이에요. | ||
| ::: | ||
|
|
||
| ## 실습 문제 |
There was a problem hiding this comment.
여기서 제목과 본문을 구분해서 쓰는 것도 중요하지만, 그보다 훨씬 중요한 건 본문에서 어떤 내용을 콜아웃으로 빼보면 좋을지를 보여주는 것일 듯 해요.
There was a problem hiding this comment.
요건 그대로 두고 문제를 하나 더 추가했어요!
docs: 실습 문제 추가
docs/visualization/index.md
Outdated
| - **리스트**: 항목을 간단하게 나열해서 내용을 빠르게 스캔할 수 있어요. 절차가 있으면 번호를 쓰고, 순서와 상관없으면 글머리 기호를 써요. | ||
| - **표**: 여러 항목을 비교하거나 구조화된 정보를 깔끔하게 정리해요. | ||
| - **코드 블록**: 예시 코드를 보기 좋게 보여주고 그대로 복사할 수 있어요. 사용 방법이나 설정 예시를 안내할 때 사용해요. | ||
| - **인라인 코드**: 문장 안에서 함수 이름이나 변수 같은 코드 요소를 구분해서 보여줘요. |
There was a problem hiding this comment.
요것들도 하나씩 추가해서 한 번에 머지되는 거쥬?
There was a problem hiding this comment.
네 맞아요 그렇게 생각하고 있었습니닷!
Co-authored-by: Jaem <91131509+DarkChocoJaem@users.noreply.github.com>
docs/visualization/list.mdx
Outdated
|
|
||
| ## 체크 리스트 | ||
|
|
||
| ### ✅ 흐름이 있는 설명에는 목록을 사용하지 마세요 |
There was a problem hiding this comment.
아예 구체적으로 작성해 봤는데 어떨까요? docs: 표현을 구체적으로 수정
| ### 데이터 정합성 문제 | ||
| 캐시는 실제 데이터와 차이가 날 수 있어요. 캐시 만료 정책이 적절하지 않으면 오래된 데이터를 반환할 수 있어서, 데이터 갱신 전략을 함께 설계해야 해요. | ||
| ``` | ||
| 특징을 heading으로 분리했어요. 설명이 길어도 제목을 기준으로 내용을 나눠서 읽을 수 있기 때문에 각 특징을 쉽게 이해할 수 있어요. |
Co-authored-by: juyeon-han-tw <107836605+juyeon-han-tw@users.noreply.github.com>
Co-authored-by: juyeon-han-tw <107836605+juyeon-han-tw@users.noreply.github.com>
Co-authored-by: juyeon-han-tw <107836605+juyeon-han-tw@users.noreply.github.com>
Co-authored-by: brassjin <80200568+brassjin@users.noreply.github.com>
수정한 내용
이 변경이 필요한 이유 (선택)
확인이 필요한 내용
체크리스트