여기를 클릭하여 도와주세요. 데이비드 맥머리 웹 호스팅 비용: 가능한 금액을 기부해 주세요!
온라인 기술 저작물은 무료로 제공됩니다.
A 핸드북여기서 정의하고 있는 것은 다음의 조합입니다:
- 개념 정보
- 지침 정보
- 참고 정보
특정 청중의 필요에 맞춰 특정 주제에 집중합니다. 이 책을 사용하여 기술 작문 과정을 수강하고 있다면, 여러분의 핸드북 프로젝트는 반드시 각각의 세 가지 요소를 어떤 형태로든 포함하세요. 더욱이, 이러한 요소들은 귀하의 핸드북 프로젝트에 자연스럽고 논리적인 "적합성"을 가져야 합니다.
이 챕터의 NotebookLM 생성 인포그래픽
핸드북 기본 사항
개념. 개념적 정보는 사물이 어떻게 작동하는지, 어떻게 구성되는지를 설명합니다. 더 복잡한 지침을 따르려면, 지침을 수행하기 위해 몇 가지 개념, 이론, 배경, 원리를 알아야 합니다. 자신의 색상을 수정하거나 생성할 수 있는 소프트웨어 기능의 예를 생각해 보세요. Photoshop, Illustration, CorelDraw 또는 Paint Shop Pro와 같은 것을 사용하여 이를 하는 것은 실제 버튼과 슬라이더를 사용하는 것이 쉽습니다. 하지만 색조, 강도, 밝기, 채도, 밀도, 대비, RGB를 이해하는 것은 어렵습니다. 필요한 색상을 만들기 위해서는 컴퓨터 색채 이론을 알아야 합니다.
다른 예를 생각해 보세요: 간단한 리눅스 파일 시스템 명령어 —ls, cd, cp, mv, pwd. 이 명령어들을 사용하려면 파일과 디렉토리가 무엇인지, 그리고 아마도 운영 체제가 무엇인지와 와일드카드에 대해서도 이해해야 합니다. 이 기본 개념들을 이해하지 못하면, 이 명령어들을 —사용하는 방법을 —지침에 따라 이해할 수 없습니다.
지침. 기본 개념을 이해한다면, 단계별 절차를 지능적으로 따라갈 수 있습니다. 지침은 절차를 신중하게 안내하는 익숙한 번호 매기기 목록입니다. 지침은 어디에나 있으며, 제품 포장지나 가전제품 및 컴퓨터에 포함된 사용자 안내서에서 찾아볼 수 있습니다.
참조. 마지막 정보 카테고리는 조회 정보 또는 빠른 참조 정보입니다. 위의 파일 시스템 예제를 따랐다면, 먼저 파일, 디렉토리, 와일드카드 개념을 배우고 이해해야 했습니다. 그러고 나서 디렉토리 변경, 파일 복사, 삭제 또는 이동에 대한 지침을 따라 이해할 수 있었습니다. 하지만 시간이 지나면 더 이상 지침이 필요하지 않지만, 가끔 지침 섹션에 포함되지 않은 특별한 요구 사항이 생기거나 지침 섹션에서 다뤄진 특정 절차를 기억하지 못할 때가 있습니다. 이럴 때 기본 참조 정보가 필요합니다: 그 섹션으로 가서 빠르게 찾아보면 됩니다.
그리고 더 시간이 지나면, 더 이상 개념 섹션이나 지침 섹션이 필요하지 않게 된다: 그 절차에 너무 익숙해져서, 마음속에 기억하게 된다. 하지만 가끔 작은 세부 사항을 잊어버리거나, 한 번도 해본 적이 없는 특별한 작업이 있을 때 —그때는 참고 섹션을 확인한다. 아마도 개념과 지침 섹션을 떼어내서 버려도 될 것이다. 당신이 항상 필요한 것은 참고 섹션뿐이다.
핸드북 형식 및 스타일
이 책을 사용하는 기술 작문 과정에서는 제목, 목록, 공지, 그래픽, 표, 문서화 및 서문의 사용에 대한 구체적인 지침을 따라야 할 수 있습니다:
핸드북 프로토타입. 아래 링크에서 핸드북의 더미 버전을 받을 수 있습니다. 여기에는 필요한 모든 페이지가 좋은 형식으로 포함되어 있습니다. 이 Word 문서에는 작업을 더 쉽게 하고 여러분의 전문 기술을 추가할 수 있는 단락 및 문자 스타일이 포함되어 있습니다.
콘텐츠 프로토타입. 목차의 프로토타입은 특히 유용합니다: 전문적인 모양의 목차를 작성하기 위한 워드 스타일을 제공합니다. 왼쪽 및 오른쪽 정렬과 리더 점을 올바르게 맞추는 것은 어렵습니다:
핸드북 예시
여기에 핸드북 예시 링크가 몇 개 있습니다. 예시들에는 몇 가지 문제가 있으니 유의하시기 바랍니다. 그 중 대부분은 제가 언급한 문제들입니다. 이들 중 일부는 경계선에 있는 핸드북입니다. 저에게 핸드북의 정의는 개념 논의, 지침, 그리고 참고 정보의 존재입니다.
핸드북을 위한 AI 프롬프트
일반적으로 읽히지 않는 체크리스트는 약간의 수정으로 AI 프롬프트의 원천으로 사용될 수 있습니다. 다음 내용을 복사하여 Google의 제미니와 같은 AI 시스템에 붙여넣고 놓친 것이 무엇인지 확인하세요.
참고: 기술 문서 또는 그 구성 요소의 내용, 형식, 스타일에 대한 모든 참조는 다음에서 확인할 수 있습니다. 온라인 기술 작문 교과서.
곧 출시됩니다!
이 챕터에 대한 당신의 생각, 반응, 비판을 부탁드립니다: 당신의 응답—데이비드 맥머리.
