배움과 기술

다른 사람이 시험할 수 있는 설명서 쓰기

시작 조건, 단계별 한 동작, 관찰 가능한 결과를 적고 독자가 해 보게 하세요.

알려진 시작 상태에서 다른 사람이 따라 할 수 있으면 설명을 평가하기 쉽습니다. 구체적인 결과 하나를 위한 짧은 절차를 쓰세요.

  1. 도구, 접근 권한, 기존 파일 등 사전 준비물을 밝힙니다. 성공을 알아볼 수 있게 최종 결과를 설명합니다.
  2. 각 단계에 명확한 동작과 대상을 적습니다. 파일을 처리하라는 표현 대신 프로젝트 폴더에 사본을 저장하라고 구체화합니다.
  3. 실수하기 쉬운 단계 뒤에는 눈으로 확인할 기준을 넣습니다. 무엇이 보여야 하고 그렇지 않으면 어디서 멈출지 설명합니다.
  4. 작업을 모르는 사람이 설명만으로 안전한 예시를 해 보게 합니다. 머뭇거리거나 빠진 정보를 묻는 지점을 기록합니다.

부족한 부분을 고치고 바뀐 단계를 다시 시험합니다. 배경 설명은 모든 동작을 끊지 말고 필요한 단계 가까이에 놓으세요.

함께 나누는 이야기

0

덧붙이고 싶은 내용이 있나요? 대화를 시작해 보세요.

당신의 생각을 들려주세요.

경험을 나누거나 실용적인 질문을 남겨보세요. 댓글은 검토 후 공개됩니다.

연락처는 공개되지 않습니다. 정보 이용 방식은 다음 문서에서 확인하세요: 개인정보 처리방침.

편안하게 둘러보세요.

유용한 아이디어를 익숙한 언어로.

ENEnglish JA日本語 DEDeutsch FRFrançais ESEspañol ITItaliano NLNederlands RUРусский PTPortuguês PLPolski KO한국어 THไทย TRTürkçe

이야기를 들려주세요.

질문이나 개선 제안, 궁금한 점을 자유롭게 보내주세요.

연락처는 공개되지 않습니다. 정보 이용 방식은 다음 문서에서 확인하세요: 개인정보 처리방침.

좋은 아이디어를 이곳에.

유용한 내용을 커뮤니티와 나눠보세요. 모든 게시물은 공개 전에 검토합니다.

무엇을 공유하고 싶나요?
주제

연락처는 공개되지 않습니다. 정보 이용 방식은 다음 문서에서 확인하세요: 개인정보 처리방침.