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