Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[테크니컬 라이팅] 쑤쑤(현수연) 미션 완성본 제출합니다. #589

Open
wants to merge 14 commits into
base: soosoo22
Choose a base branch
from

Conversation

soosoo22
Copy link

@soosoo22 soosoo22 commented Oct 30, 2024

테크니컬 라이팅 v2 제출합니다.
suspense와 친해지기

Copy link

@BadaHertz52 BadaHertz52 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

안녕하세요. 쑤쑤 Suspense에 대한 글 잘 읽었어요.
쑤쑤의 글을 읽으면서 좋았던 점과 아쉬웠던 점을 정리해봤어요. 쑤쑤에게 도움이 되었으면 좋겠네요! 😄🎀 바쁜 미션,프로젝트를 수행하며 글 작성하느라 고생했어요.

좋았던 점

Suspense 로딩을 이미지로 나타내서 이해하기 좋았어요. 여러 Suspense가 중첩된 경우와 병렬적으로 선언한 경우에 대한 내용을 생각해보지 않아서 신선하다고 느껴졌고 글의 이해를 도와주는이미지 첨부가 좋았어요. 또한 글의 주제와 내용이 일관되고 명확한 것 같아요.

아쉬웠던 점

  • useGetReviewList에 대한 코드가 없는데, “useGetReviewList 훅에서 useSuspenseQuery를 이용해 데이터를 받아오는데 useSuspenseQuery란 무엇일까요"라는 문구는 왜 있을까요?
  • useSuespenseQuery 설명을 코드 형식에서 하다보니, 글을 읽을 때 가로 스크롤로 읽어야해서 불편했어요. 코드를 설명하는게 아닌데, 왜 코드 형식을 사용했지?라는 의문이 들었어요.
  • useEffect, 이벤트 핸들러 내부에 비동기 작업 상태를 Suspense가 감지하지 못하는 예시 코드가 있었으면, useEffect, 이벤트 핸들러에서의 비동기 작업 상태의 문제점을 이해하는 데 도움이 되지 않았을 까하는 아쉬움이 있어요.
  • 헤더 순서가 일관적이지 않고, 해당 헤더를 사용한 이유나 글의 구조가 잘 이해되지 않았어요.
    아래는 쑤쑤의 글에서 헤더를 정리하고 괄호에 해당 구조를 보며 든 저의 생각들이에요.
 # Suspense와 친해지기 
    ### Suspense란  (🤔 왜 h1 다음에 h3가 오는거지?)
    ### Suspense 기본 문법
    ### Suspense는 비동기 작업의 상태를 어떻게 감지할까?
    ### Suspense 사용 이유
    ### 데이터 로딩 처리 ( 🤔 구조를 보았을때, Suspense 사용 이유의 하위 부문 같은데 왜 같은 헤더를 사용하는거지?)
    ### Suspense 사용 예제
    #### 코드 스플리팅  (🤔 Suspnese 사용 예제에 왜 코드 스플리팅이 하위에 있지? Suspense를 활용한 부분이라서 그런건가? 사용 예제는 정말 사용 예시 같은 느낌이 드는데)
    #### LayoutShift ( 🤔 이거는 단점인데 사용예제 일까? 엮는다면, 단점이라는것을 느낌표보다는 문구로 나타내는 게 좋지 않을까?  )

@ImxYJL
Copy link

ImxYJL commented Nov 5, 2024

아까 얘기 나눴던 부분들 코멘트로 다시 한 번 달게요 ㅎㅎ

좋았던 점

  • 이미지와 표 덕분에 내용을 이해하기 쉬웠어요.
    • 특히 suspense를 중첩으로 설명하는 파트에서 이미지 덕분에 별도의 상상력을 동원하지 않고도 술술 읽을 수 있었습니다.
  • Suspense에 대한 전반적인 개념과 활용을 모두 다루고 있어 suspense를 잘 모르는 사람이 읽으면 좋을 것 같다는 생각이 들었습니다.
    • suspense의 입문이라는 주제(?)에 맞게 친절한 어투가 잘 어울리는 것 같아요
    • 전반적인 개념을 다루었음에도 다른 곳으로 새지 않고 딱 필요한 내용만 설명했다는 느낌을 받았습니다.

개선해보면 좋을 것 같은 점

  • Suspense의 비동기 작업 상태 감지 부분에서, rejected 설명에 “에러 경계를 사용하여 에러를 처리할 수 있다”는 부분이 있는데 글에서 대부분의 용어를 영어 원문으로 설명하고 있으니 여기서도 Errorboundary라고 적으면 좋을 것 같아요
  • hydration에 대한 설명이 필요할 것 같아요
    • 예상 독자는 잘 모르겠지만, suspense에 대한 기본 설명을 읽는 독자라면 hydration이 뭔지 잘 모를 것 같아요. 우테코 내에서도 이에 대해 잘 알고 있는 사람이 많지 않았던 것 같고요! (사실저도모름)
    • 더 기본 개념(?)인 비동기 작업에 대해서는 별도의 설명이 있어서 얘도 있으면 좋을 것 같아요
  • 사소한 부분이지만, 예시 설명에서 ReviewList처럼 도메인 특화된 이름 대신 더 단순하고 추상적인 List로만 설명해도 될 것 같아요 (글 뒷부분은 심플하게 잘 되어 있었어요)
  • useSuspenseQuery 내용은 아예 빼거나 아예 한 섹션을 할애해서 설명하는 게 좋을 것 같아요
  • 중반부부터 문체에서 약간 G 선생의 향기가 납니다 ㅋㅋㅋ

쑤쑤의 장점인 뚜렷한 이미지화와 딱딱하지 않은 문체가 잘 드러나는 글이라고 생각했어요! 글 쓰느라 수고 많았어요~~

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants