<

이 장에서는, 책 디자인 "는 책의 다양한 전형적인 구성 요소의 내용, 스타일, 형식, 디자인 및 순서를 의미합니다. "Components"는 여기서 판권 고지, 서문, 색인, 또는 앞표지나 뒷표지와 같은 책의 실제 섹션이나 페이지를 지칭합니다. 이 문맥에서 페이지 디자인 장, 용어 요소 책의 거의 모든 곳에서 여러 번 발생할 수 있는 것들(예: 머리글, 바닥글, 표, 삽화, 목록, 공지, 강조 표시 등)을 가리킨다.

다음은 인쇄된 기술 서적의 전형적인 구성 요소들과 그 구성 요소들의 전형적인 내용, 형식, 스타일 및 순서에 대한 개요를 제공합니다. 물론 어떤 단일 사용자 안내서, 기술 참조 매뉴얼, 빠른 참조 문서 또는 그와 유사한 다른 문서가 실제로 이 모든 구성 요소들을 지금 읽게 될 것과 정확히 같은 방식으로 설계되고 배열되어 있지는 않을 것입니다. 대신, 이 검토는 가능한 것들에 대한 개요를 제공할 것입니다—가능성의 범위라고 할 수 있습니다.

참고: 현재 우리는 예제만 가지고 있습니다. 사용자 가이드 FrameMaker에서 개발되어 PDF로 출력되었습니다. 용어집은 없지만, 일반적인 사용자 가이드의 다른 모든 구성 요소는 갖추어져 있습니다. (저는 '파일패드'의 그 'd'가 무엇인지 모르겠어요!) 아래에 나열된 일부 글꼴 및 여백 요구사항을 준수하지 않습니다.

다음 내용을 읽기 시작하기 전에 하드웨어와 소프트웨어 관련 서적을 여러 권 준비하여 여기에서 논의되는 내용과 그 책들의 내용, 스타일, 형식 및 구성(순서)을 비교해 보세요.

여기에서 보시는 것보다 더 자세한 내용을 원하시면 다음 두 가지 표준 업계 자료를 참조하세요:

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

앞면 및 뒷면 표지

구입 고객을 위한 제품 문서는 내부 품질이 싸구려 수준이더라도 보통 잘 디자인된 앞표지를 가지고 있다. 앞표지에는 일반적으로 다음 항목들 중 일부 또는 전부가 포함된다:

회사명, 제품명, 책 제목의 적절한 형식을 정하는 것은 어려울 수 있습니다. 때로는 이것들이 한 단락 전체의 텍스트가 되기도 합니다! 회사들은 앞표지에 버전 및 출시 번호를 표시할지 여부에 대해 꽤 의견이 갈립니다—어떤 회사들은 표시하고, 어떤 회사들은 표시하지 않습니다. 그러나 거의 항상 플랫폼이 표시되어 있는 것을 볼 수 있습니다—제품이 Macintosh용인지, PC용인지, UNIX용인지 등.

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

제목 페이지

타이틀 페이지는 일반적으로 앞표지의 복제본이지만 일부 요소는 생략된다. 일반적으로 생략되는 것은 삽화, 회사나 제품 로고 및 슬로건이다. 일부 기술 간행물은 불필요해 보이는 중복 때문에 타이틀 페이지를 아예 생략하기도 한다. (인쇄 부수가 20,000부일 때는 한 페이지의 차이가 크게 작용한다!)

판 공지

판 공지는 일반적으로 기술 간행물에서 일반 텍스트가 처음으로 등장하는 부분이지만, 보통 더 작은 활자로 되어 있다. 표제지의 뒷면에 나온다. 기술 출판사가 간소화·친환경 방식을 택해 표제지를 없앨 경우, 판 공지는 앞표지의 뒷면에 표시된다.

아무도 작은 글씨를 읽는 것을 좋아하지 않지만, 판 공지에 일반적으로 포함되는 문구들을 살펴보세요:

면책 조항

다음 섹션을 참조하세요 에디션 공지사항, 면책 조항은 보통 숨겨져 있는 곳인데. 제품이나 그 발행물이 면책 조항 때문에 아예 별도의 페이지가 필요하다면, 난 그걸 사지 않을 거야!

상표

비록 많은 회사들이 자신들의 상표와 다른 회사들의 상표를 그 안에 나열하긴 하지만 판 공지, 일부는 판 고지 바로 다음의 별도 페이지에 그것들을 나열하는 것을 선호합니다. 이러한 배치 결정은 거의 전적으로 회사 변호사들의 권한입니다. 작가로서 책 디자인이나 문체 측면에서 그 결정이 아무리 나빠 보여도 따라야 할 수도 있습니다. 기억하세요, 해당 책에 등장하는 상표 등록된 제품명만 나열해야 합니다.

일부 출판물에서는 상표에 대해 지나칠 정도로 신경 쓰는 경우가 있습니다: 상표가 붙은 제품 이름의 첫 등장이나 심지어 모든 등장마다 별표를 붙이거나 각주를 달기도 합니다. 그러나 다시 말하지만, 이것들은 기술 문서 작성자들이 안타깝게도 받아들여야 하는 회사 변호사들의 지침입니다.

보증

추가적인 법적 사항입니다. 이들은 회사가 자사 제품에 관해 지원하는 "보증"입니다. 때때로 이것들은 책의 앞부분에 게재되기도 하지만, 책 디자인 관점에서는 별도의 카드에 인쇄되어 책이나 제품의 수축 포장 안에 삽입되는 것이 더 적절합니다. 다시 말하지만, 판본 고지와 마찬가지로, 이것은 단순히 표준 문구로 가져와 책의 적절한 위치에 배치하는 텍스트입니다.

그러나 회사들은 때때로 판 공지, 안전 공지, 보증, 커뮤니케이션 성명서 등 여러 버전을 유지하고 있다는 점을 알아야 합니다. 작성자로서 올바른 버전을 사용하고 있는지 반드시 확인해야 합니다(어떤 것이 정확한지 알아내는 과정에서 회사 내의 많은 새로운 사람들을 만날 기회가 생길 것입니다!). 그리고 무엇을 하든지, 아무리 형편없이 작성되어 있더라도 이러한 상용 문구의 텍스트를 변경하지 마십시오. 변경 사항은 일반적으로 회사 변호사들의 승인을 받아야 합니다(그들은 보통 마지못해 승인해 주며, 귀하의 많은 노력과 상당한 시간이 지난 후에야 승인합니다).

안전 주의사항

하드웨어 제품의 설명서에는 일반적으로 앞부분에 안전 고지 섹션이 있습니다. 예를 들어, 이것은 서문의 하위 절로 포함되거나 독립된 별도의 섹션일 수 있습니다. 이러한 섹션은 일반적으로 책 전반에 걸쳐 나타나는 모든 위험, 경고 및 주의 고지들을 모아 어떤 논리적인 방식으로 정리합니다. 그러나 이러한 사전 경고가 있더라도 하드웨어 설명서에서는 개별 고지들을 해당되는 지점에 그대로 배치합니다. (자세한 내용은 특별 공지사항.)

의사소통 성명

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

목차

목차(TOC)는 일반적으로 독자가 더 정확하게 필요한 내용을 찾을 수 있도록 최소한 두 수준의 세부 항목(실제 본문의 헤드 1들)을 포함한다. 작가, 편집자, 그리고 책 디자이너들은 대개 목차의 순서에 대해 논쟁한다. 사용성 측면에서는 목차를 가능한 한 책 앞부분, 아니면 책의 맨 처음에 두는 것이 훨씬 좋다. 그러나 법적 측면에서는 모든 커뮤니케이션 고지, 보증서, 저작권, 상표, 안전 안내문 등이 먼저 나와야 한다고 우려한다. 사용성이 우세한 곳에서는 책들이 이러한 법률적 내용을 서문 앞부분에서 빼내기 위해 가능한 모든 수단을 동원한다: 보증서는 별도의 카드로 만들어 책이나 제품과 함께 슈링크 포장하고; 보증서, 커뮤니케이션 고지, 상표 등은 부록으로 밀어 넣기도 한다.

깔끔하게 서식이 지정된 목차를 만드는 데 문제가 있나요? 자세히 보기: 전문적으로 보이는 목차 만들기

그림 목록

일반 사용자를 위한 기술 설명서에는 일반적으로 그림 목록이 없습니다. 사실 그림 자체에는 일반적으로 본격적인 그림 제목이 붙지 않습니다. 하지만 그렇다고 해서 기술 설명서에 그림 목록이 필요 없다는 뜻은 아닙니다. 모든 것은 독자와 독자의 필요—그리고 책의 내용에 달려 있습니다. 책에 표, 삽화, 차트, 그래프 등 독자가 직접 찾아보기를 원하는 항목이 포함되어 있다면 그림 목록이 적절합니다.

서문

서문의 기능은 독자들이 책을 읽을 준비를 하게 하는 것이다. 그것은 다음과 같은 방식으로 이루어진다:

전통적인 도서 출판에서는 서문이 목차보다 앞에 나오지만, 앞서 논의한 바와 같이 목차 섹션에서는 기술 출판 관계자들이 사용성 때문에 목차를 책의 앞부분에 배치하기를 원한다.

본문 장

아, 맞아요, 이 책들에는 실제 텍스트가 있습니다—전부 앞부분(서문 등)만 있는 건 아니에요! 여기서 딱히 더 할 말은 없고, 대부분의 기술 서적에는 장이나 절이 있고, 경우에 따라 파트도 있습니다. 에 관한 장을 보세요 페이지 디자인 머리글, 바닥글, 제목, 목록, 공지, 표, 그래픽, 교차 참조 및 강조 표시와 같은 요소의 형식, 스타일 및 디자인 문제에 대해

부록

아시다시피, 부록은 책의 본문에 들어가기에 적절하지는 않지만 책에서 빼놓을 수 없는 자료를 위한 것입니다. 부록은 종종 크고 다루기 어려운 표를 싣는 장소입니다. 일부 기술 간행물에는 부록에 보증서와 같은 항목이 들어 있습니다. 형식 면에서, 부록은 장—다만 "부록 A"와 같이 이름이 붙고, 머리말과 바닥글도 그 다른 번호 매기기 및 명명 규칙(부록 A의 페이지는 A-1, A-2 등)에 맞게 되어 있습니다.

용어집

일부 기술 간행물에는 전문 용어와 그 정의를 모아둔 섹션이 포함되어 있다. 대부분의 용어집은 2단 레이아웃을 사용한다. 일반적으로 각 용어와 그 정의는 별도의 단락을 이루며, 용어는 소문자(고유명사인 경우는 제외)로 굵게 표시하고 뒤에 마침표를 찍은 다음 일반 로만체로 정의를 적는다. 또한 정의는 대체로 완전한 문장이 아니다. 좋은 용어집 정의는 정식 문장 정의 기법을 사용해야 한다. 정의 장 이 온라인 텍스트의. 여러 정의는 일반적으로 괄호 안의 아라비아 숫자로 식별됩니다. 용어집 단락에는 또한 보다 선호 용어에 대한 참조 및 같이 보기 관련 용어에 대한 참조.

인덱스

색인은 일반적으로 두 열로 구성되며 또한 포함합니다 보기 선호 용어에 대한 참조 및 같이 보기 관련 용어에 대한 참조입니다. 해당 장을 참조하십시오. 인덱싱 우수한 인덱스를 만들기 위한 프로세스 및 지침

독자 반응 양식

인터넷과 소셜 미디어의 등장 이전에는 일부 기술 간행물에 독자가 책에 대한 의견, 질문 및 평가를 보낼 수 있도록 종이 양식이 포함되어 있었습니다. 물론 이러한 양식은 대개 그 책이 설명하는 제품의 기능 결함에 대한 불만을 더 많이 끌어내는 것으로 밝혀졌습니다. 인터넷의 등장으로 이 양식들은 온라인으로 옮겨졌고, 책들은 단지 그 양식의 온라인 위치를 가리키기만 합니다.

책 디자인 및 레이아웃

일반적으로 하드웨어 및 소프트웨어 제조업체가 제작하는 사용자 안내서와 매뉴얼은 다소 간결하고 소박하게 설계됩니다. 하이테크 기업들은 때때로 제품의 새로운 버전과 릴리스를 9개월마다 출시합니다. 이러한 상황에서는 정교한 디자인이 실용적이지 않습니다. 다음은 흔히 볼 수 있는 레이아웃 및 디자인 특징들입니다:

참고: 이로써 종이책에 대한 논의를 마칩니다. 구성 요소. 인쇄된 책 디자인에 대한 이 개요를 완성하려면, 해당 장을 참조하세요 페이지 디자인, 이는 포함합니다 요소들 예: 머리글 및 바닥글, 제목, 목록, 특별 공지, 표, 그래픽, 강조 표시, 교차 참조 등.

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