Là một nhà viết kỹ thuật, bạn sẽ thường phải tạo mục lục cho các cuốn sách in và cho các trợ giúp trực tuyến mà bạn phát triển. Loại mục lục mà chúng tôi đề cập ở đây là mục lục cổ điển ở cuối sách, cho thấy số trang mà các chủ đề và tiểu chủ đề xuất hiện trong cuốn sách. Một mục lục trực tuyến tương tự như vậy, chỉ khác là bạn cung cấp các liên kết siêu văn bản thay vì số trang.
Mục lục trong tài liệu in
Mục lục trong hệ thống trợ giúp trực tuyến (khung bên trái)
Phác thảo một chỉ mục
Như với bất kỳ dự án viết nào, có một giai đoạn phác thảo thô cho việc lập chỉ mục. Và tất nhiên, bạn cần nghĩ về khán giả của mình—họ là ai, họ sẽ sử dụng chỉ mục như thế nào, tại sao họ sẽ sử dụng nó, và những loại thuật ngữ mà họ có thể quen thuộc. Sau đó, đây là những gì cần làm tiếp theo:
- Chuyển đổi mỗi tiêu đề thành nhiều mục chỉ mục. Tiêu đề là một nơi tốt để bắt đầu: chúng chỉ ra các chủ đề và tiểu chủ đề—chính xác như những gì một bảng mục lục thực hiện. Tuy nhiên, đừng chỉ sao chép tiêu đề trực tiếp vào bảng mục lục và rời đi. Như bạn sẽ thấy bên dưới, bạn cần liệt kê chéo các mục dựa trên tiêu đề theo nhiều cách càng thực tế càng tốt.
- Liệt kê chéo từng mục. Sắp xếp lại từng mục dựa trên tiêu đề của bạn theo nhiều cách thực tế nhất có thể. Ví dụ, một tiêu đề như "Thay đổi độ phân giải màn hình" có thể được ghi chỉ mục là "độ phân giải màn hình, thay đổi" cũng như "thay đổi độ phân giải màn hình." Bạn cũng có thể bao gồm "thay đổi độ phân giải, màn hình." Những mục chỉ mục chéo này cố gắng dự đoán tất cả các cách mà người đọc có thể tìm kiếm chủ đề này trong một chỉ mục: "màn hình," "độ phân giải," hoặc "thay đổi."
Dưới đây là một số ví dụ bổ sung:
Tiêu đề Mục lục Tối ưu hóa hiển thị video hiển thị video, tối ưu hóa
tối ưu hóa hiển thị video
hiển thị, tối ưu hóa videoChơi Truyền phát Đa phương tiện truyền phát đa phương tiện, phát trực tiếp
chơi đa phương tiện phát trực tuyến
đa phương tiện, phát trực tuyếnCơ Bản Về Mạng mạng lưới
mạng lướiGiới thiệu về Truyền thông Đa phương tiện Streaming truyền phát đa phương tiện
đa phương tiện, phát trực tuyến
Lưu ý rằng bạn không thể luôn luôn chỉ định mục từ chéo cho mọi từ. Ví dụ, "giới thiệu truyền thông đa phương tiện" ở trên sẽ không khả thi. Có độc giả nào tìm kiếm chủ đề này bắt đầu bằng "giới thiệu" không? - Tạo mục từ đồng nghĩa. Độc giả không nhất thiết sử dụng cùng một thuật ngữ như bạn trong tài liệu của mình. Họ có thể gọi một ổ đĩa đĩa mềm là "floppy drive." Họ có thể gọi màn hình là "monitor." Là một người lập chỉ mục, bạn phải dự đoán những biến thể thuật ngữ phổ biến này. Trong các mục trước, sẽ rất tốt nếu có một từ đồng nghĩa cho "màn hình video" như "monitor." Nhưng thay vì lặp lại số trang, hãy sử dụng một Xem tham khảo. Bằng cách này, bạn chỉ ra cho người đọc thuật ngữ được ưu tiên. (Tất nhiên, nếu chỉ có một số trang, chỉ cần lặp lại nó với mục từ đồng nghĩa.)
Dưới đây là một số ví dụ bổ sung:
Mục lục Các mục từ đồng nghĩa âm lượng, điều chỉnh âm lượng, điều chỉnh tốc độ truyền tải tốc độ, truyền tải ghi video sao chép video - Xem xét văn bản để thêm mục chỉ mục. Thông thường, chỉ ghi chỉ mục theo tiêu đề là không đủ. Bạn phải đào sâu trong văn bản để tìm các khái niệm, thuật ngữ và nhiệm vụ không được thể hiện bởi các tiêu đề. Ví dụ, dưới tiêu đề "Tạo luồng đa phương tiện," bạn có thể thấy các định nghĩa về "ghi lại" và "mã hóa." Đây là những thuật ngữ quan trọng, nhưng chúng không xuất hiện ở bất kỳ đâu trong các tiêu đề—cũng nên ghi chỉ mục cho chúng! Trong trường hợp này, bạn sẽ muốn tạo các mục chỉ mục bổ sung này: "ghi lại luồng" và "mã hóa luồng."
- Mục lục phần đầu và phần cuối. Đừng quên tìm hiểu trong lời nói đầu, thông báo an toàn, phụ lục và các tài liệu khác để tìm thêm các mục chỉ mục. Thông thường, số điện thoại và địa chỉ hỗ trợ kỹ thuật được hiển thị trong lời nói đầu. Chỉ mục chúng—và đừng quên tạo các mục chỉ mục chéo và mục đồng nghĩa cho chúng nữa.
Mục lục Bản sao và mục từ đồng nghĩa hỗ trợ kỹ thuật hỗ trợ, kỹ thuật
bàn hỗ trợ
vấn đề
Sửa đổi và Hoàn thiện một Chỉ mục
Khi bạn đã nghĩ ra tất cả các mục chỉ mục mà bạn có thể nghĩ ra, đã đến lúc xem chỉ mục trông như thế nào và bắt đầu chỉnh sửa nó. Để chỉnh sửa một chỉ mục bản thảo thô:
- Xây dựng chương mục bản nháp đầu tiên. Sau khi bạn đã tạo ra nhiều mục chỉ mục, danh sách chéo và từ đồng nghĩa nhất có thể, đã đến lúc "xây dựng" một bản nháp đầu tiên của mục lục. Trừ khi bạn đang làm theo cách truyền thống với các thẻ chỉ mục, bạn có thể để phần mềm của mình thực hiện điều này cho bạn. Ví dụ, nếu bạn làm việc trong một hệ thống xuất bản trên máy tính, bạn đã xem qua văn bản của mình và chèn các mục chỉ mục. Quá trình tương tự áp dụng cho các công cụ tạo trợ giúp. Khi bạn xây dựng mục lục bản nháp đầu tiên, đừng cảm thấy thất vọng. Đó chỉ là một bản nháp thô, mà bạn sẽ cần phải chỉnh sửa nhiều loại khác nhau.
- Vứt bỏ các mục không cần thiết. Trong các bước trước, bạn đã phác thảo sơ bộ chỉ mục. Ở giai đoạn đó, bạn không cần quá bận tâm về cách diễn đạt chính xác của các mục hoặc khả năng mà ai đó sẽ sử dụng chúng. Nhưng bây giờ là thời điểm để bắt đầu loại bỏ các mục mà không độc giả nào sẽ sử dụng. Ví dụ, các mục cấp một bắt đầu bằng "giới thiệu," "sử dụng," "về" không có khả năng hữu ích. Hãy xóa chúng! Nhưng đừng xóa chúng khỏi chỉ mục đã tạo. Hãy quay lại tài liệu của bạn và loại bỏ mục chỉ mục gốc.
- Tập hợp các mục có cách diễn đạt tương tự. Bạn cũng sẽ thấy nhiều mục có chỉ những biến thể nhỏ trong cách diễn đạt. Ví dụ:
Bản nháp thô Các mục đã sửa đổi công nghệ, truyền phát đa phương tiện
công nghệ, truyền phát đa phương tiệncông nghệ, truyền thông đa phương tiện trực tuyến màn hình video
màn hình videomàn hình video thay đổi độ phân giải màn hình
thay đổi độ phân giải màn hìnhthay đổi độ phân giải màn hình
Như bạn có thể thấy trong những ví dụ này, các mục số ít/số nhiều và các biến thể động từ là nguyên nhân phổ biến nhất gây ra cách diễn đạt tương tự trong các mục chỉ mục. Phong cách viết của bạn có thể yêu cầu sử dụng số ít thay vì số nhiều. Dù bạn xử lý theo cách nào, hãy nhất quán. - Nhóm các mục tương tự. Bạn cũng sẽ thấy các mục cần được nhóm lại và phân cấp. Ví dụ, chúng có thể đều bắt đầu bằng cùng một từ, nhưng có các bổ nghĩa khác nhau. Dưới đây là một ví dụ:
Các mục tương tự Các mục nhóm và phụ thuộc máy chiếu, được định nghĩa
máy chiếu, biên soạn
máy chiếu, những điều cần xem xét
máy chiếu, tạo ra
máy chiếu, khắc phục sự cố
máy chiếu biên dịch
các yếu tố cần xem xét
tạo ra
được định nghĩa
khắc phục sự cố
- Chỉnh sửa các mục có số lượng trang quá nhiều. Một số tổ chức có quy tắc hướng dẫn cụ thể về số lượng tham chiếu trang cho phép theo một mục mục lục. Ba là số tối đa phổ biến; hai là quyết đoán, tham vọng. Ví dụ, "cú pháp lập trình, 12, 45, 74, 122, 219, 222." Một chuỗi các tham chiếu trang không tên như vậy không giúp ích cho ai. Thay vào đó, hãy xác định tiểu đề cho các tham chiếu trang này. Đây là một ví dụ:
Có quá nhiều tham chiếu trang không xác định Các mục phụ thuộc và được gán nhãn máy chiếu, 124, 136, 154-155, 156 157 máy chiếu
biên soạn, 154-155
các cân nhắc, 156
các điều khiển, 136
được định nghĩa, 124, 136, 157
Một điểm rất hay mà bạn không thường thấy trong các chỉ mục là phạm vi trang mà một chủ đề được thảo luận—ngay cả khi không có các mục con. Nếu nó chính xác, bạn có thể có một mục như sau: "máy chiếu, 126–137" - Tìm kiếm các nhóm đầu vào. Một yếu tố hữu ích trong việc lập chỉ mục là tìm kiếm cách để bạn nhóm các mục lại với nhau. Ví dụ, hãy tưởng tượng một hướng dẫn người dùng mô tả các hộp thoại khác nhau xuất hiện trong ứng dụng. Có hộp thoại Mật khẩu, hộp thoại Người dùng mới, hộp thoại Xóa người dùng, và những thứ khác nữa. Thế còn việc lặp lại tất cả những mục đó dưới mục "hộp thoại" thì sao?
Các mục nhập Các mục được nhóm lại (các mục được phân tán khắp chỉ mục) Hộp thoại Thêm Người dùng
...
Hộp thoại xóa người dùng
...
Hộp thoại người dùng mới
...
Hộp thoại mật khẩuHộp thoại Thêm Người dùng
...
Hộp thoại xóa người dùng
...
hộp thoại
Thêm người dùng
Xóa người dùng
Người dùng mới
Mật khẩu
...
Hộp thoại người dùng mới
...
Hộp thoại mật khẩu- Tìm kiếm các mục nâng cấp. Trong công việc lập chỉ mục của bạn, có thể bạn sẽ có một số mục con cần được chuyển thành các mục chính.
Nhập liệu Các mục được đẩy lên
(các mục được rải rác khắp mục lục)pin
vứt bỏ, 33
cảnh báo nổ, 34
đề xuất của nhà sản xuất, 34
độ phân cực, 33-34
mua sắm, 33
thay thế, 33-34
thẻ, 33(hình minh họa)
pin
vứt bỏ, 33
cảnh báo nổ, 34
đề xuất của nhà sản xuất, 34
độ phân cực, 33-34
mua sắm, 33
thay thế, 33-34
tab, 33(hình minh họa)
xử lý, pin, 33
...
polarity, pin, 33-34
...
cảnh báo, pin, 34
...
Trong ví dụ này, người biên mục nghĩ rằng một số (có thể không nhiều) độc giả sẽ tìm "polarity" trước khi tìm "batteries, polarity." Tương tự, người biên mục nghĩ rằng mọi người có thể tìm "disposing" trước. Mặc dù những khả năng như vậy là nhỏ, nhưng vẫn nên đưa chúng vào chỉ mục.- Tìm kiếm Xem thêm và thêm vào Xem tài liệu tham khảo. Về cuối giai đoạn sửa đổi của bạn, hãy xem xét chỉ mục của bạn để có khả năng Xem thêm tài liệu tham khảo. Xem thêm tài liệu tham khảo là cho các thuật ngữ liên quan chặt chẽ mà độc giả có thể chọn nhầm. Ví dụ, trong các hệ thống DOS cũ, có Sao chép lệnh và xcopy lệnh. Hai lệnh này liên quan chặt chẽ với nhau về tên gọi cũng như chức năng đến nỗi bạn sẽ muốn đặt Xem thêm tham chiếu đến nhau. Và đừng quên Xem tham chiếu: những điểm này hướng người đọc từ các thuật ngữ đồng nghĩa đến các thuật ngữ mà bạn thích sử dụng và lập chỉ mục trong cuốn sách của bạn.
- Kiểm tra phong cách và cơ chế của các mục mục lục. Tổ chức mà bạn làm việc có thể có hướng dẫn phong cách riêng hoặc hướng dẫn bạn tới một phong cách tiêu chuẩn nào đó như Hướng dẫn phong cách Chicago. Hãy xem xét những điều này rất cẩn thận để biết cách viết hoa và dấu câu cho các mục chỉ mục. Các chỉ mục thường sử dụng chữ thường cho tất cả các mục không phải danh từ riêng, nhưng một tỷ lệ nhất định sử dụng chữ cái đầu tiên viết hoa cho các mục cấp một. Hầu hết các kiểu yêu cầu bạn đặt một dấu phẩy ngay sau mục chỉ mục và trước các số trang; nhưng một vài thì không. Một số kiểu yêu cầu bạn sử dụng cùng một cách đánh dấu trong chỉ mục như bạn đã làm trong văn bản chính. Nếu một cái gì đó được in đậm trong văn bản chính, họ cũng muốn nó in đậm trong chỉ mục.
Ghi chú: Chương này sử dụng nhiều kiểu dấu câu và viết hoa—không phải để làm bạn bối rối, mà để làm bạn nhận thức được sự biến thể trong phong cách.
Một phong cách chỉ số phổ biến Một kiểu chỉ mục phổ biến khác máy chiếu, 123
biên dịch, 154-155
cân nhắc, 156
các điều khiển, 136
được định nghĩa, 124, 136, 157
hồ sơ dự án, 451-461
máy chiếu
biên soạn 154-155
cân nhắc 156
điều khiển 136
định nghĩa 124, 136, 157
Hồ sơ dự án 451-461
Lưu ý trong ví dụ bên phải rằng không có dấu phẩy giữa thuật ngữ chỉ mục và các tham chiếu trang. Ngoài ra, bạn sẽ thấy rằng một số tiêu chuẩn và phong cách lập chỉ mục không tán thành việc có tham chiếu trang trong một mục chỉ mục có các mục con: ví dụ, "máy chiếu, 123" trong ví dụ bên trái. Tại sao tham chiếu trang 123 không nằm trong số các mục con? Chủ đề phụ trên trang 123 là gì?
Tôi rất trân trọng những suy nghĩ, phản ứng và chỉ trích của bạn về chương này: phản hồi của bạn.
Thông tin và chương trình được cung cấp bởi mcmassociates.io, 1995-2026.
Công việc này được cấp phép dưới een Giấy phép Creative Commons Ghi công Quốc tế 4.0. - Tìm kiếm các mục nâng cấp. Trong công việc lập chỉ mục của bạn, có thể bạn sẽ có một số mục con cần được chuyển thành các mục chính.