이 장에서, 책 디자인 이는 책의 다양한 일반 구성 요소의 내용, 스타일, 형식, 디자인 및 순서를 의미합니다. 여기서 "구성 요소"는 판별 공지, 서문, 색인 또는 앞표지나 뒷표지와 같은 책의 실제 섹션이나 페이지를 지칭합니다. 페이지 디자인 챕터, 그 용어 원소 책 어디에서나 여러 번 발생할 수 있는 요소를 의미하며, 여기에는 머리말, 바닥글, 표, 삽화, 목록, 공지 사항, 강조 표시 등이 포함됩니다.

다음은 인쇄된 기술서적의 전형적인 구성 요소와 그 구성 요소의 전형적인 내용, 형식, 스타일 및 순서에 대한 개요를 제공합니다. 분명히, 단일 사용자 가이드, 기술 참조 매뉴얼, 빠른 참조 문서 또는 기타 문서가 지금 읽고 있는 방식으로 모든 구성 요소를 정확하게 설계하고 순서를 매길 수는 없습니다. 대신, 이 리뷰는 가능성, 즉 가능성의 범위에 대한 개요를 제공합니다.

주목: 현재 우리는 예시만 가지고 있습니다. 사용자 가이드 FrameMaker에서 개발된 후 PDF로 출력되었습니다. 용어집은 없지만, 일반적인 사용자 안내서의 다른 모든 요소는 갖추어져 있습니다. ("Filepad"에서 "d"가 무엇인지 모르겠어요!) 아래에 나열된 일부 글꼴 및 여백 요구 사항을 사용하지 않는다는 점에 유의하세요.

다음 내용을 읽기 전에 여러 가지 하드웨어 및 소프트웨어 책을 손에 잡아 그들의 내용, 스타일, 형식 및 구성 방식을 여기서 논의하는 것과 비교해 보세요.

여기에서 보는 것보다 더 많은 세부정보를 원하시면 다음 두 가지 표준 산업 자료를 참조하십시오:

이 책 구성 요소의 예를 볼 수 있습니다. 기술 문서 디자인.

앞표지와 뒷표지

유료 고객을 위한 제품 문서는 일반적으로 내부 품질이 저급하더라도 잘 디자인된 전면 커버를 가지고 있습니다. 전면 커버에는 보통 다음 중 일부 또는 전부가 표시됩니다:

회사의 이름, 제품 이름, 책 제목에 대한 좋은 형식을 찾는 것은 어려울 수 있습니다. 때때로, 이는 целая 단락에 해당할 수도 있습니다! 회사들은 전면 표지에 버전 및 릴리스 번호를 표시할 것인지에 대해 상당히 나뉘어 있습니다—어떤 회사는 표시하고, 어떤 회사는 표시하지 않습니다. 하지만 거의 항상 플랫폼이 표시되는 것을 볼 수 있습니다—제품이 맥킨토시, PC, 유닉스 등 어떤 용도인지를 나타내죠.

하드카피 사용자 가이드 및 매뉴얼의 뒷면 표지는 보통 매우 간단합니다. 일반적으로, 책 주문 번호, 적절한 상표 기호가 있는 회사 이름, 저작권 기호와 책의 소유권에 대한 문구, 그리고 책이 인쇄된 국가에 대한 문구가 포함됩니다. 또한, 뒷면 표지에는 바코드도 있습니다. 소프트웨어가 바코드를 생성할 수 있는지 확인해 보세요. 바코드 유틸리티에 액세스하여 책 주문 번호를 입력하면 유틸리티가 바코드를 생성합니다.

제목 페이지

제목 페이지는 일반적으로 앞표지의 복사본이지만 특정 요소는 생략됩니다. 일반적으로 생략되는 것은 삽화, 회사 또는 제품 로고 및 슬로건입니다. 일부 기술 출판물은 불필요한 중복처럼 보이기 때문에 아예 제목 페이지를 생략합니다. (그리고 20,000부 인쇄에서는 한 페이지가 많은 의미가 있습니다!)

판본 공지

판본 공지는 일반적으로 기술 간행물에서 정규 텍스트의 첫 번째 인스턴스이며, 일반적으로 작은 글씨로 표시됩니다. 제목 페이지의 뒷면에 위치합니다. 기술 출판사가 슬림하고 친환경적인 접근 방식을 취하여 제목 페이지를 없애는 경우, 판본 공지는 앞표지의 뒷면에 나타납니다.

아무도 세부 사항을 읽는 것을 좋아하지 않지만, 발행 공지에 일반적으로 포함되는 설명서를 살펴보세요:

면책 조항

해당 섹션을 참조하세요. 판 확인 공지, 일반적으로 조그맣게 숨겨져 있는 면책조항. 만약 제품이나 그 출판물에 면책조항을 위한 별도의 페이지가 필요하다면, 나는 그걸 사지 않을 거야!

상표

많은 회사들이 자사와 타사의 상표를 나열하긴 하지만 판본 공지, 일부는 이를 별도의 페이지에 표시하길 선호하며, 판권 고지 다음에 위치하게 됩니다. 이러한 배치 결정은 거의 전적으로 회사 변호사들의 영역입니다; 작가로서 당신은 책 디자인이나 글쓰기 스타일 측면에서 결정이 아무리 나쁘더라도 어쩔 수 없이 따를 수 있습니다. 기억하세요, 당신은 그 특정 책에 등장하는 상표가 등록된 제품 이름만 나열합니다.

일부 출판물은 상표에 대해 극단적인 조치를 취하는 것을 볼 수 있습니다: 첫 번째 또는 심지어 매번 상표가 붙은 제품 이름에 별표를 붙이거나 각주를 달기도 합니다. 그러나 다시 말하지만, 이는 회사 변호사들의 지시에 따른 것으로 기술 작성자는 슬프게도 이를 수용해야 합니다.

보증서

더 많은 법적 사항입니다. 이것들은 회사가 제품에 대해 지원할 "보증"입니다. 때때로 이들은 책의 앞부분에 게시되지만, 보다 적절한 책 디자인 관점에서는 별도의 카드에 인쇄되어 책이나 제품의 수축 포장 안에 삽입됩니다. 다시 말해, 에디션 공지와 마찬가지로, 이 텍스트는 단순히 "보일러플레이트"로 가져와 책 안의 올바른 위치에 배치하는 것입니다.

그러나, 회사들이 에디션 공지, 안전 공지, 보증서, 커뮤니케이션 성명서 등 여러 가지 버전을 유지하는 경우가 있다는 점을 알아두어야 합니다. 작가로서, 당신은 올바른 버전을 사용하고 있는지 확인해야 합니다(어떤 것이 올바른지 알아내는 과정에서 당신은 회사에서 많은 새로운 사람들을 만날 기회를 얻을 수 있습니다!). 그리고 무엇을 하든, 이러한 표준 항목의 텍스트를 변경하지 마세요, 아무리 형편없이 작성되었더라도요. 변경 사항은 일반적으로 회사 변호사에게 승인을 받아야 하며(그들은 보통 마지못해 그렇게 하며, 당신의 많은 노력과 시간이 지난 후에야 가능합니다).

안전 공지

하드웨어 제품은 일반적으로 책의 맨 앞에 안전 주의 사항 섹션을 가지고 있습니다. 이는 예를 들어 서문 섹션의 하위 섹션으로 존재할 수도 있고, 별도의 섹션으로 마련될 수도 있습니다. 이러한 섹션은 일반적으로 책 전반에 걸쳐 발생하는 모든 위험, 경고 및 주의 사항을 모아 논리적인 방식으로 정리합니다. 그러나 이러한 사전 경고에도 불구하고 하드웨어 책은 여전히 개별 공지를 해당하는 지점에 배치합니다. (자세한 내용은 참조하세요) 특별 공지사항.)

커뮤니케이션 선언문

하드웨어 책에는 이러한 제품이 배송되는 국가의 정부에 의해 규정된 통신 진술서도 필요합니다. 미국에서는 FCC가 하드웨어 제품의 "클래스"에 따라 특정 통신 진술서를 요구합니다. 작가로서, 문서화하는 제품에 적절한 통신 진술서를 사용하고—진술서를 어떤 방식으로도 수정하지 않도록 주의해야 합니다(신성한 법적 용어!).

목차

목차(TOC)는 일반적으로 독자들이 더 정확하게 필요한 내용을 찾을 수 있도록 최소한 두 번째 수준의 세부 정보를 포함합니다(실제 텍스트의 헤드 1). 작가, 편집자, 책 디자인자는 일반적으로 목차의 순서에 대해 논의합니다. 사용성 측면에서 볼 때, 목차는 책의 앞부분에 가능한 한 가깝게 배치하는 것이 훨씬 더 낫습니다. 그러나 법적인 측면에서는 모든 커뮤니케이션 진술, 보증, 저작권, 상표 및 안전 고지가 먼저 와야 한다고 사람들이 걱정합니다. 사용성이 우선시되는 곳에서는, 책은 이 법률적인 자료를 전면에서 빼내기 위해 가능한 모든 전술을 사용합니다: 보증서는 별도의 카드에 넣고 책이나 제품과 함께 수축 포장합니다; 보증서, 커뮤니케이션 진술, 상표 및 기타 사항들은 부록에 넣어버릴 수 있습니다.

잘 정리된 목차를 만드는 데 어려움이 있으신가요? 보세요. 전문적인 목차 만들기

도표 목록

일반 사용자를 위한 기술 매뉴얼에는 일반적으로 그림 목록이 없습니다. 사실, 그림 자체에도 일반적으로 완전한 제목이 없습니다. 하지만 그림 목록이 기술 매뉴얼에 들어갈 자리가 없다고 말할 수는 없습니다. 이는 모두 독자와 독자의 필요— 및 책의 내용에 달려 있습니다. 만약 책에 독자가 직접 찾아보고 싶어하는 표, 일러스트, 차트, 그래프 및 기타 자료가 포함되어 있다면, 그림 목록이 필요합니다.

서문

서문의 기능은 독자들이 책을 읽을 준비를 하도록 돕는 것입니다. 이는 다음과 같은 방법으로 이루어집니다:

전통적인 책 출판에서, 서문은 목차 전에 위치하지만, 앞서 논의된 바와 같이 목차 섹션, 기술 출판 담당자들은 사용성을 위해 책에서 목차가 더 일찍 나와야 한다고 원합니다.

본문 장들

아, 맞아요, 이 책들에는 실제 텍스트가 있습니다—모두 전서가 아니에요! 여기서 할 말은 별로 없고, 대부분의 기술 서적에는 장이나 섹션이 있으며, 경우에 따라 부분이 있습니다. 장을 보세요. 페이지 디자인 형식, 스타일 및 디자인 문제에 대한 요소로는 머리말, 바닥글, 제목, 목록, 공지, 표, 그래픽, 교차 참조 및 하이라이트가 포함됩니다.

부록

아시다시피, 부록은 책의 본문에 잘 맞지 않지만 책에서 빼놓을 수 없는 자료를 위한 것입니다. 부록은 종종 크고 다루기 힘든 표를 위한 장소입니다. 일부 기술 출판물에서는 부록에 보증서와 같은 내용이 포함되어 있습니다. 형식상으로 부록은 단락과 동일하지만— "부록 A"와 같이 이름이 정해지며, 헤더와 푸터는 그 다른 번호 매기기 및 이름 규칙(A-1, A-2 등)을 따릅니다.

용어집

일부 기술 출판물은 전문 용어와 그 정의에 대한 섹션을 포함합니다. 대부분의 용어집이 두 개의 열 레이아웃을 사용한다는 점에 유의하십시오. 일반적으로 각 용어와 그 정의는 별도의 단락으로 구성되며, 용어는 소문자로 작성되고(고유 명사가 아닌 경우) 굵게 표시되며, 마침표가 뒤따르고, 그 다음에 일반 로마체로 정의가 이어집니다. 정의는 일반적으로 완전한 문장이 아니라는 점도 주목하십시오. 좋은 용어집 정의는 설명된 형식적 문장 정의 기법을 사용해야 합니다. 정의 장 이 온라인 텍스트의 다수의 정의는 일반적으로 괄호 안에 아라비아 숫자로 표시됩니다. 용어집 단락에도 포함되어 있습니다. 보다 선호하는 용어에 대한 참고사항 및 또한 보기 관련 용어에 대한 참고 문헌.

색인

인덱스는 보통 두 개의 열로 구성되며 또한 포함됩니다. 보다 선호 용어에 대한 언급 및 또한 참고하십시오 관련 용어에 대한 참조. 장을 참조하십시오. 인덱싱 좋은 색인을 만들기 위한 프로세스와 가이드라인.

독자 반응 양식

인터넷과 소셜 미디어의 발전 이전에, 일부 기술 출판물에는 독자들이 의견, 질문 및 책에 대한 평가를 보낼 수 있도록 하는 하드카피 양식이 포함되어 있었습니다. 물론, 이러한 양식은 책에서 문서화된 제품의 기능 결함에 대한 불만을 더 자주 유도하는 것으로 드러났습니다. 인터넷의 발전과 함께 이러한 양식은 온라인으로 옮겨졌고, 책들은 단지 그들의 온라인 위치를 가리키고 있습니다.

책 디자인 및 레이아웃

일반적으로 하드웨어 및 소프트웨어 제조업체에서 생산하는 사용자 가이드와 매뉴얼은 다소 간결하고 소박한 방식으로 디자인됩니다. 첨단 기술 회사는 가끔 9개월마다 제품의 새로운 버전과 릴리스를 개발합니다. 이러한 맥락에서 정교한 디자인은 실용적이지 않습니다. 다음은 여러분이 볼 수 있는 전형적인 레이아웃 및 디자인 특징입니다:

노트: 이로써 인쇄 책에 대한 논의가 종료됩니다. 부품. 인쇄된 책 디자인 개요를 완성하려면, 다음 장을 참조하세요. 페이지 디자인, 이라는 부분을 포함하여 요소들 머리말 및 꼬리말, 제목, 목록, 특수 공지, 표, 그래픽, 강조, 교차 참조 등.

이 챕터에 대한 당신의 생각, 반응, 비판을 주시면 감사하겠습니다: 당신의 응답.