기술 작가로서, 일반적으로 인쇄된 책과 당신이 개발하는 온라인 도움말에 대한 색인을 만들어야 합니다. 여기서 우리가 의미하는 색인 유형은 책 뒤쪽에 있는 고전적인 색인으로, 주제와 하위 주제가 책 내에서 나타나는 페이지 번호를 보여줍니다. 온라인 색인은 페이지 번호 대신 하이퍼텍스트 링크를 제공한다는 점을 제외하면 거의 동일합니다.
인쇄 문서의 목차
온라인 도움말 시스템의 색인 (왼쪽 패널)
색인 초안 작성
모든 글쓰기 프로젝트와 마찬가지로, 색인을 위한 초안 작성 단계가 있습니다. 그리고 물론, 청중에 대해 생각해야 합니다—그들이 누구인지, 색인을 어떻게 사용할 것인지, 왜 사용할 것인지, 어떤 용어에 익숙할 것인지요. 그 다음에는 다음과 같은 단계를 진행하세요:
- 각 제목을 여러 인덱스 항목으로 변환하십시오. 목차는 시작하기에 좋은 장소입니다: 그것은 주제와 하위 주제를 정확하게 나타내며, 인덱스가 하는 일과 같습니다. 그러나 제목을 인덱스에 그냥 복사해서 걸어두지 마십시오. 아래에서 보시겠지만, 가능한 한 많은 방법으로 제목 기반 항목을 교차 목록으로 만들어야 합니다.
- 각 항목을 교차 목록으로 작성하세요. 각 제목 기반 항목을 가능한 한 많은 실용적인 방법으로 재배열하십시오. 예를 들어, "화면 해상도 변경"과 같은 제목은 "해상도, 화면 변경"뿐만 아니라 "화면 해상도 변경"으로 색인화할 수 있습니다. "해상도, 화면 변경"도 포함할 수 있습니다. 이러한 교차 목록 항목은 독자가 이 주제를 색인에서 찾을 수 있는 모든 가능한 방법을 예상하려고 합니다: "화면," "해상도," 또는 "변경."
여기에 몇 가지 추가 예시가 있습니다:
제목 색인 항목 비디오 디스플레이 최적화 비디오 디스플레이, 최적화
비디오 디스플레이 최적화
디스플레이, 비디오 최적화스트리밍 멀티미디어 재생 스트리밍 멀티미디어, 재생
스트리밍 멀티미디어 재생
멀티미디어, 스트리밍 재생네트워킹 기초 네트워킹
네트워크스트리밍 멀티미디어 소개 스트리밍 멀티미디어
멀티미디어, 스트리밍
모든 단어에서 색인 항목을 항상 교차 목록화할 수는 없다는 점을 주목하세요. 예를 들어, 이전의 "스트리밍 멀티미디어 소개"는 전혀 작동하지 않을 것입니다. 어떤 독자가 "소개"로 시작하여 이 주제를 찾을까요? - 동의어 항목 만들기. 독자는 문서에서 사용하는 용어와 반드시 동일한 용어를 사용하지 않습니다. 그들은 디스켓 드라이브를 "플로피 드라이브"라고 부를 수 있습니다. 그들은 디스플레이를 "모니터"라고 부를 수 있습니다. 색인 작성자로서, 이와 같은 일반적인 용어 변화를 미리 예측해야 합니다. 이전 항목에서는 "비디오 디스플레이"의 동의어인 "모니터"를 사용하는 것이 좋습니다. 그러나 페이지 번호를 반복하는 대신, 사용하세요. 보다 참고. 그렇게 하면 독자들에게 선호하는 용어를 안내할 수 있습니다. (물론, 페이지 번호가 하나만 있을 경우, 동의어 항목과 함께 그것을 반복하면 됩니다.)
여기 몇 가지 추가 예시가 있습니다:
색인 항목 동의어 항목 볼륨, 조정 중 소리 크기, 조정하기 전송 속도 속도, 변속기 비디오 캡처하기 비디오 복사 중 - 추가 색인 항목에 대한 텍스트 검토. 일반적으로 제목으로만 색인을 만드는 것은 충분하지 않습니다. 텍스트에서 제목으로 나타나지 않는 개념, 용어 및 작업을 찾아야 합니다. 예를 들어, "멀티미디어 스트림 만들기"라는 제목 아래에서 "캡처"와 "인코딩"의 정의를 볼 수 있습니다. 이들은 중요한 용어이지만, 제목 어디에도 나타나지 않습니다. 이들 역시 색인에 포함해야 합니다! 이 경우, 다음과 같은 추가 색인 항목을 만드는 것이 좋습니다: "스트림 캡처"와 "스트림 인코딩".
- 색인 전면 및 후면 내용. 서문, 안전 공지, 부록 및 기타 주변 자료에서 추가 색인 항목을 찾는 것을 잊지 마세요. 일반적으로 기술 지원 번호와 주소는 서문에 표시됩니다. 이들을 색인화하고 교차 목록 항목 및 동의어 항목도 생성하는 것을 잊지 마세요.
색인 항목 클론 및 동의어 항목 기술 지원 지원, 기술
헬프 데스크
문제들
색인 수정 및 조정
모든 색인 항목을 생각해냈다면, 이제 색인이 어떻게 보이는지 확인하고 수정 작업을 시작할 시간입니다. 초안 색인을 수정하려면:
- 첫 초안 색인 작성하기. 여러 가지 색인 항목, 교차 리스트 및 동의어를 최대한 작성한 후, 색인의 첫 번째 초안을 "작성"할 시간입니다. 색인 카드로 구식 방식으로 작업하지 않는 한, 소프트웨어 애플리케이션이 이를 대신할 수 있습니다. 예를 들어, 데스크톱 출판 시스템에서 작업하는 경우, 텍스트에 색인 항목을 삽입하는 과정을 거쳤습니다. 도우미 저자 도구에도 동일한 과정이 적용됩니다. 첫 번째 초안 색인을 작성할 때 실망하지 마세요. 이것은 단지 초안일 뿐이며, 여러 종류의 수정을 적용해야 합니다.
- 쓸모없는 항목을 버리세요. 앞서 단계에서 여러분은 색인의 초안을 거칠게 작성해왔습니다. 그 단계에서는 항목의 정확한 문구나 누군가가 이를 사용할 가능성에 대해 신경 쓰지 않았습니다. 하지만 이제는 독자가 절대 사용하지 않을 항목을 제거할 시간입니다. 예를 들어, "소개", "사용", "에 대한"으로 시작하는 1단계 항목들은 유용할 가능성이 낮습니다. 이를 삭제하세요! 하지만 구축된 색인에서 삭제하지 마세요. 문서로 돌아가 원래의 색인 항목을 제거하세요.
- 유사한 phrasing의 항목을 통합하십시오. 또한 문구에 약간의 변형만 있는 항목이 많이 있습니다. 예를 들어:
초안 항목 수정된 항목 기술, 스트리밍 멀티미디어
기술, 스트리밍 멀티미디어기술, 스트리밍 멀티미디어 비디오 디스플레이
비디오 디스플레이비디오 디스플레이 화면 해상도 변경
화면 해상도 변경화면 해상도 변경
이 예에서 볼 수 있듯이, 단수/복수 항목과 동사 변형은 색인 항목에서 유사한 표현의 가장 일반적인 원인입니다. 귀하의 스타일 가이드에서는 복수형 대신 단수형을 사용하는 것을 규정할 수 있습니다. 어떤 방식으로 처리하든 일관성을 유지하세요. - 유사한 항목을 그룹화하세요. 또한 그룹화되고 하위화해야 하는 항목들을 볼 수 있습니다. 예를 들어, 모든 항목이 같은 단어로 시작하지만 다른 수식어를 가질 수 있습니다. 다음은 예시입니다:
유사한 항목들 그룹화되고 종속된 항목들 프로젝터, 정의됨
프로젝터, 컴파일 중
프로젝터, 고려사항
프로젝터, 생성하기
프로젝터, 문제 해결
프로젝터 컴파일 중
고려 사항
생성 중
정의됨
문제 해결
- 페이지 항목이 과도한 항목을 수정하십시오. 일부 조직에서는 색인 항목 뒤에 허용되는 페이지 참조 수에 대한 실제 스타일 가이드 규칙이 있습니다. 일반적으로 세 개가 최대이며, 두 개는 공격적이고 야심 차다고 할 수 있습니다. 예를 들어, "프로그래밍 구문, 12, 45, 74, 122, 219, 222." 이러한 익명의 페이지 참조 나열은 아무에게도 도움이 되지 않습니다. 대신, 이러한 페이지 참조에 대한 하위 주제를 식별하세요. 다음은 예입니다:
확인되지 않은 페이지 참조가 너무 많습니다. 종속 및 레이블이 붙은 항목 프로젝터, 124, 136, 154-155, 156 157 프로젝터
컴파일링, 154-155
고려사항, 156
컨트롤, 136
정의된, 124, 136, 157
색인에서 흔히 볼 수 없는 아주 좋은 요소는 주제가 논의되는 페이지 범위입니다—하위 항목이 없더라도요. 만약 정확하다면, 다음과 같은 항목을 가질 수 있습니다: "프로젝터, 126–137" - 항목 그룹화를 찾아보세요. 인덱스에서 유용한 터치는 항목을 그룹화할 수 있는 방법을 찾는 것입니다. 예를 들어, 애플리케이션에서 나타나는 다양한 대화 상자를 설명하는 사용자 가이드를 상상해 보십시오. 비밀번호 대화 상자, 새 사용자 대화 상자, 사용자 삭제 대화 상자 등 여러 개가 있습니다. "대화 상자" 아래에 해당 항목들을 반복하는 것은 어떨까요?
항목들 그룹화된 항목 (항목들이 색인 전반에 걸쳐 흩어져 있습니다) 사용자 추가 대화상자
...
사용자 삭제 대화 상자
...
새 사용자 대화 상자
...
비밀번호 대화 상자사용자 추가 대화 상자
...
사용자 삭제 대화 상자
...
대화 상자
사용자 추가
사용자 삭제
새로운 사용자
비밀번호
...
새 사용자 대화 상자
...
비밀번호 대화 상자- 시프트 업 항목을 찾으세요. 색인 작업에서, 주요 항목으로 복사해야 할 서브 항목이 있을 수 있습니다.
항목들 상향 이동된 항목들
(항목들이 색인 전반에 흩어져 있습니다)배터리
처리 중, 33
폭발 경고, 34
제조업체 권장, 34
극성, 33-34
구매, 33
교체, 33-34
탭, 33(일러스트)
배터리
처리, 33
폭발 경고, 34
제조업체 권장, 34
극성, 33-34
구매, 33
교체, 33-34
탭, 33(삽화)
배터리 처리, 33
...
극성, 배터리, 33-34
...
경고, 배터리, 34
...
이 예에서 색인자는 일부 (아마도 많지는 않은) 독자들이 "전극"을 "배터리, 전극"보다 먼저 찾을 것이라고 생각했습니다. 마찬가지로, 색인자는 사람들이 "처리하기"를 먼저 찾을 것이라고 생각했습니다. 이러한 가능성이 작더라도 어쨌든 색인에 포함시키세요.- 찾아보세요 또한 보기 그리고 추가적인 보다 참고 문헌. 수정 단계의 끝 무렵에, 색인을 살펴보아 가능성을 확인하세요. 또한 보십시오 참고문헌. 또한 보십시오 참조는 독자가 실수로 선택할 수 있는 밀접하게 관련된 용어들에 대한 것입니다. 예를 들어, 오래된 DOS 시스템에서는 복사 명령 및 xcopy 명령. 두 명령은 이름과 기능이 매우 밀접하게 관련되어 있어 당신은 넣고 싶을 것입니다. 또한 보기 서로에 대한 언급. 그리고 잊지 마세요. 보다 참고 문헌: 독자를 당신이 선호하는 용어와 책에서 사용하여 색인화한 용어로 안내하는 동의어 용어입니다.
- 색인 항목의 스타일과 메커니즘을 확인하세요. 귀하가 일하는 조직은 자체 스타일 가이드가 있을 수 있으며, 표준 스타일을 참조할 수도 있습니다. 시카고 스타일 매뉴얼. 이들을 매우 주의 깊게 살펴보세요. 색인 항목을 대문자로 작성하고 문장 부호를 사용하는 방법을 알려줍니다. 색인은 일반적으로 고유 명사가 아닌 항목에 대해 소문자를 사용하지만, 특정 비율은 1차 항목에서 첫 글자를 대문자로 사용합니다. 대부분의 스타일에서는 색인 용어 뒤와 페이지 번호 앞에 쉼표를 넣도록 되어 있지만, 일부는 그렇지 않습니다. 일부 스타일에서는 색인에서 본문과 동일한 강조를 사용해야 합니다. 본문에서 굵게 표시된 것이 있다면, 색인에서도 굵게 표시되기를 원합니다.
노트: 이 장에서는 다양한 구두점 및 대문자 스타일을 사용합니다— 여러분을 혼란스럽게 하려는 것이 아니라, 스타일의 변동성을 인식하게 하려는 것입니다.
하나의 일반적인 색인 스타일 또 다른 일반적인 색인 스타일 프로젝터, 123
컴파일링, 154-155
고려사항, 156
컨트롤, 136
정의됨, 124, 136, 157
프로젝트 프로필, 451-461
프로젝터
154-155 컴파일 중
고려사항 156
컨트롤 136
정의된 124, 136, 157
프로젝트 프로필 451-461
오른쪽 예제에서 인덱스 용어와 페이지 참조 사이에 쉼표가 없다는 점에 주목하세요. 또한, 일부 인덱싱 기준 및 스타일에서는 하위 항목이 있는 인덱스 항목에 페이지 참조를 두는 것을 반대하는 경우가 있습니다. 예를 들어, 왼쪽 예제에서 "프로젝터, 123"이 그렇습니다. 왜 페이지 123 참조가 하위 항목 중간에 없습니까? 페이지 123의 하위 주제는 무엇입니까?
이 장에 대한 귀하의 생각, 반응, 비판을 듣고 싶습니다: 당신의 응답.
- 시프트 업 항목을 찾으세요. 색인 작업에서, 주요 항목으로 복사해야 할 서브 항목이 있을 수 있습니다.
