읽기 좋은 기술 글의 구성

문장과 근거

글의 구조에 마우스를 올리거나 클릭하면 짧은 설명과 관련 글을 확인할 수 있습니다.

하나의 원고가 서로 다른 읽기 환경에서도 같은 뜻을 전달하도록. 이 글은 블로그의 읽기 환경을 확인하는 중립적인 문법 샘플입니다. 실제 서비스 운영이나 개인의 성과를 설명하지 않습니다.

짧은 문단에는 하나의 생각을 담습니다. 중요한 말은 굵게, 용어나 식별자는 inline code로 구분합니다. 표와 취소선 같은 문법은 GitHub Flavored Markdown에 정의되어 있습니다.¹

설명을 줄이기 전에, 설명 사이의 연결이 남아 있는지 확인합니다.

다음은 렌더링을 확인하기 위한 편집용 예시입니다.

입력과 출력을 가까이 두면 예제를 따라 읽기 쉽습니다. 아래 코드는 화면 표시를 위한 작은 예제입니다. 두 번째 줄은 강조됩니다.

example.ts

const numbers = [1, 2, 3];
const doubled = numbers.map((number) => number * 2);
console.log(doubled); // [2, 4, 6]

인라인 수식 $a + b = c$ 는 문장의 일부로 읽습니다. 독립적인 수식은 별도 줄에 놓습니다.

\frac{1}{n}\sum_{i=1}^{n} x_i = \bar{x}

이 수식은 값들의 산술평균을 나타냅니다. 아래 그림은 초안에서 검토를 거쳐 완성본으로 이어지는 흐름을 보여 줍니다.

이미지의 설명은 캡션으로, 이미지를 보지 못할 때 필요한 내용은 대체 텍스트로 전달합니다.