sings.dev
EN
목차
Essay

1분 읽기

운영자를 위한 글쓰기

기술 문서는 구조를 감탄하게 하기보다, 다음 행동을 돕는 쪽으로 쓰일 때 더 좋아집니다.

좋은 기술 문서는 혼란과 올바른 다음 행동 사이의 거리를 짧게 만듭니다.

질문에서 시작하기

사람들은 대개 무언가가 불분명하거나 느리거나 고장 났을 때 문서를 엽니다.

명령은 맥락 가까이에 두기

독자가 다음 단계에 도달하기 위해 긴 이론을 먼저 스크롤하지 않게 해야 합니다.

의식보다 복구를 우선하기

아무도 쓰지 않는 완벽한 문서보다, 필요한 순간의 정확한 한 줄이 더 큰 가치를 가집니다.

글쓴이 소개

Sam

차분한 시스템 설계, 백엔드 구조, 오래 유지할 수 있는 웹의 작은 판단들을 기록합니다.

토론

댓글