독자와 환경을 먼저 정하기
독자의 경험 수준과 책을 읽은 뒤 할 수 있을 일을 정하세요. 모든 배경지식을 다루기보다 필요한 선수 지식을 명시하는 편이 명확합니다.
운영체제, 언어 및 도구 버전, 설치 조건을 정리하고 예제가 검증된 기준 시점을 기록합니다.
예제에 목적과 결과 넣기
코드를 보여주기 전에 무엇을 만들고 왜 필요한지 설명합니다. 실행 명령과 기대 결과를 함께 제시하면 독자가 진행 상태를 확인할 수 있습니다.
긴 코드는 의미 있는 단위로 나누고, 중요한 줄은 주변 맥락과 함께 설명합니다. 실제 비밀번호나 접근 토큰은 예제에 넣지 마세요.
독자가 막힐 지점 살피기
설치 실패, 경로 차이, 권한 문제처럼 처음 접하는 사람이 자주 만나는 상황을 생각해 보세요. 오류 해결에 필요한 단서와 확인 순서를 덧붙입니다.
서로 다른 환경의 동작을 확인하지 못했다면 조건을 분명하게 밝혀 독자가 적용 범위를 판단하도록 돕습니다.
최신성과 권리 확인
인용한 문서, 그림, 코드의 출처와 사용 조건을 확인하고 출간 전 실행 테스트를 다시 진행합니다. 기술은 바뀌므로 예제에 적용한 버전과 변경 가능성을 알려주세요.
타인의 코드나 회사 자료는 공개 및 재사용 권한을 확인한 뒤 사용합니다.
