루안 이펑 선생님께서 "기술 문서 작성의 ruanyifeng.com/blog/2024/01/w…ps://t.co/jsyZ1WRxUO 기술 문서를 쓸 때 저는 종종 두 가지 간단한 구조를 사용합니다. 1. 그것은 무엇입니까? 왜 그렇습니까? 어떻게 해야 합니까? 2. 문제를 식별하고, 문제를 분석하고, 문제를 해결합니다. 기술 문서를 작성할 때는 작성 후 누락된 부분이 없는지 확인하세요. 예를 들어, 흔한 실수는 해결책을 제시하지 않고 "무엇"과 "왜"에만 집중하여 독자에게 배울 점을 남기지 않는 것입니다. 또는 단순히 코드를 붙여넣어 문제나 분석 과정을 설명하지 않고 해결책만 제시하는 경우도 있습니다. 하지만 모든 기술을 동원해도 더 많이 쓰는 데는 역부족입니다!
스레드를 불러오는 중
깔끔한 읽기 화면을 위해 X에서 원본 트윗을 가져오고 있어요.
보통 몇 초면 완료되니 잠시만 기다려 주세요.