Là một nhà văn kỹ thuật, bạn thường phải tạo mục lục cho sách in và cho các tài liệu 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, hiển thị số trang mà các chủ đề và tiểu chủ đề xuất hiện trong sách. Một mục lục trực tuyến thì tương tự nhưng bạn cung cấp các liên kết siêu văn bản thay vì số trang.
Mục trong tài liệu in ấn
Chỉ mục trong hệ thống trợ giúp trực tuyến (bảng bên trái)
Phác thảo thô một chỉ mục
Cũng giống như bất kỳ dự án viết nào, có một giai đoạn phác thảo thô cho việc chỉ mục. Và tất nhiên, bạn cần suy nghĩ về khán giả của mình—họ là ai, cách họ sẽ sử dụng chỉ mục, lý do họ sẽ sử dụng nó và loại thuật ngữ nào mà họ có thể quen thuộc. Sau đó, đây là những gì bạn 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ủ đề—đúng như những gì một chỉ mục làm. Tuy nhiên, đừng chỉ sao chép tiêu đề trực tiếp vào một chỉ mục và bỏ đ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 có tiêu đề của bạn theo càng nhiều cách thực tiễn càng tốt. Ví dụ, một tiêu đề như "Thay đổi độ phân giải màn hình" có thể được 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 "độ phân giải, thay đổi màn hình." Những mục được chỉ danh chéo này cố gắng dự đoán tất cả những cách mà người đọc có thể tìm kiếm chủ đề này trong một 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 Đa phương tiện Trực tuyến truyền phát đa phương tiện, chơi
chơi phát trực tuyến đa phương tiện
đa phương tiện, phát trực tuyếnCơ bản về Mạng mạng lưới
các mạngGiới thiệu về Đa phương tiện Trực tuyến 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 liệt kê các mục chỉ mục trên mọi từ. Ví dụ, "giới thiệu truyền thông đa phương tiện" trước đây sẽ không hoạt động. Liệu có độc giả nào tìm kiếm chủ đề này bắt đầu với "giới thiệu" không? - Tạo các mục đồng nghĩa. Người đọc 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 bạn. Họ có thể gọi ổ đĩ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ữ thông thường này. Trong các mục trước, sẽ là một ý tưởng 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 Thấy tài liệu tham khảo. Bằng cách đó, bạn chỉ ra cho độc giả thuật ngữ được ưa chuộng. (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 Mục đồ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 quay video sao chép video - Xem xét văn bản để thêm các mục chỉ mục. Thông thường, chỉ định chỉ theo tiêu đề là không đủ. Bạn phải đào sâu vào văn bản để tìm kiế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 Một Luồng Đa Phương Tiện," bạn có thể thấy các định nghĩa về "bắt" và "mã hóa." Đây là những thuật ngữ quan trọng, nhưng chúng không xuất hiện trong các tiêu đề. Hãy chỉ mục chúng cũng vậy! Trong trường hợp này, bạn sẽ muốn tạo thêm các mục chỉ mục này: "bắt 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 kiếm trong phần lời nói đầu, thông báo an toàn, phụ lục, và các tài liệu liên quan khác để bổ sung các mục từ chỉ mục. Thông thường, các số điện thoại và địa chỉ hỗ trợ kỹ thuật được hiển thị trong phần lời nói đầu. Hãy lập chỉ mục chúng—và đừng quên tạo các mục chéo và các mục đồng nghĩa cho chúng nữa.
Mục lục Mục nhập sao chép và đồng nghĩa hỗ trợ kỹ thuật hỗ trợ, kỹ thuật
bàn trợ giúp
vấn đề
Sửa đổi và Tinh chỉnh Một Chỉ Mục
Khi bạn đã suy nghĩ ra tất cả các mục chỉ mục mà bạn có thể nghĩ đến, đã đế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 nháp thô:
- Xây dựng một chỉ mục sơ bộ. Khi bạn đã tạo ra bao nhiêu mục chỉ mục, danh sách chéo và từ đồng nghĩa mà bạn có thể, đã đến lúc "xây dựng" bản nháp đầu tiên của chỉ mục. Trừ khi bạn đang làm theo cách truyền thống với thẻ chỉ mục, bạn có thể để ứng dụng phần mềm của mình làm đ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 để chèn các mục chỉ mục. Quy trình tương tự áp dụng cho các công cụ tạo hỗ trợ. Khi bạn xây dựng chỉ mục bản nháp đầu tiên, đừng nản lòng. Đó chỉ là một bản nháp thô, mà bạn sẽ cần phải áp dụng nhiều loại chỉnh sửa khác nhau.
- Bỏ đi 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ộ mục lục. Trong giai đoạn đó, bạn không cần quá chú trọng đến cụm từ chính xác của các mục hay khả năng mà ai đó sẽ sử dụng chúng. Nhưng bây giờ là thời gian để bắt đầu loại bỏ những mục mà không độc giả nào sẽ sử dụng. Ví dụ, những mục cấp đầu tiên bắt đầu bằng "giới thiệu," "sử dụng," "về" có khả năng sẽ không hữu ích. Hãy xóa chúng! Nhưng đừng xóa chúng khỏi mục lục đã tạo. Hãy quay lại tài liệu của bạn và loại bỏ mục lục ban đầu.
- Hợp nhất các mục có cách diễn đạt tương tự. Bạn cũng sẽ tìm thấy nhiều mục chỉ có những biến thể nhỏ về cách diễn đạt. Ví dụ:
Bản nháp thô Các mục đã chỉnh sửa công nghệ, phát trực tuyến đa phương tiện
công nghệ, truyền phát đa phương tiệncông nghệ, truyền phát đa phương tiện hiển thị 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à những nguyên nhân phổ biến nhất dẫn đến cách diễn đạt tương tự trong các mục chỉ mục. Phong cách nhà của bạn có thể quy định việc sử dụng số ít thay vì số nhiều. Dù bạn xử lý những điều này như thế nào, hãy đảm bảo 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 loại. Ví dụ, chúng có thể đều bắt đầu bằng cùng một từ, nhưng có các từ bổ nghĩa khác nhau. Đây là một ví dụ:
Các mục tương tự Các mục đã được nhóm và phân cấp máy chiếu, được định nghĩa
máy chiếu, biên soạn
máy chiếu, cân nhắc
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ố xem xét
tạo ra
đã đị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 phong cách thực tế liên quan đến số lượng tham chiếu trang được phép sau một mục chỉ mục. Ba là giới hạn tối đa phổ biến; hai thì mạnh mẽ, tham vọng. Ví dụ, "cú pháp lập trình, 12, 45, 74, 122, 219, 222." Một chuỗi tham chiếu trang vô danh như thế này không giúp ích cho ai. Thay vào đó, hãy xác định tiểu đề cho những tham chiếu trang này. Đây là một ví dụ:
Quá nhiều tham chiếu trang không xác định. Các mục phụ thuộc và được đánh dấu máy chiếu, 124, 136, 154-155, 156 157 máy chiếu
biên dịch, 154-155
các yếu tố cần xem xét, 156
điều khiển, 136
đã định nghĩa, 124, 136, 157
Một điểm rất tốt mà bạn không thường thấy trong mục lục là khoảng trang mà một chủ đề được thảo luận—ngay cả khi không có các mục con. Nếu điều đó chính xác, bạn có thể có mục như thế này: "máy chiếu, 126–137" - Tìm kiếm các nhóm mục nhập. Một cách tinh tế và hữu ích trong các chỉ mục là tìm kiếm các cách mà bạn có thể nhóm các mục. Ví dụ, hãy tưởng tượng một hướng dẫn người dùng giải thích 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à cứ như vậy. Tại sao không lặp lại tất cả những mục đó dưới tiêu đề "hộp thoại"?
Danh sách nhập liệu Những 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 tăng cao. 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 sao chép ra thành mục chính.
Những mục nhập Các mục được nâng lên
(các mục được phân tán khắp chỉ mục)pin
loại bỏ, 33
cảnh báo nổ, 34
khuyến nghị của nhà sản xuất, 34
độ phân cực, 33-34
mua sắm, 33
thay thế, 33-34
tabs, 33(hình minh họa)
pin
thải bỏ, 33
cảnh báo nổ, 34
khuyến nghị 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)
thải bỏ, pin, 33
...
độ cực, 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ó lẽ không nhiều) độc giả sẽ tra "polarity" trước thay vì "batteries, polarity." Tương tự, người biên mục nghĩ rằng mọi người có thể tra "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à bổ sung 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 để tìm khả năng Xem thêm tài liệu tham khảo. Xem thêm tài liệu tham khảo dành cho những 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 có tên và chức năng liên quan đến nhau đến nỗi bạn muốn đặt Xem thêm tham chiếu lẫn nhau. Và đừng quên Xem tham chiếu: những điểm chuyển hướng người đọc từ các thuật ngữ đồng nghĩa đến các thuật ngữ bạn ưu tiên 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 chỉ mụ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 giới thiệu cho bạn một phong cách tiêu chuẩn nào đó như là Hướng Dẫn Chicago về Phong Cách. Hãy xem xét kỹ lưỡng những điều này về cách viết hoa và chấm câu trong 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 định dạng yêu cầu bạn đặt một dấu phẩy ngay sau thuật ngữ chỉ mục và trước số trang; nhưng một vài kiểu không làm vậy. Một số kiểu định dạng yêu cầu bạn sử dụng cùng một cách đánh dấu trong chỉ mục như 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ọ muốn nó cũng in đậm trong chỉ mục.
Chú ý: Chương này sử dụng nhiều phong cách 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 về sự biến đổi phong cách.
Một phong cách chỉ mục phổ biến Một phong cách chỉ mục phổ biến khác máy chiếu, 123
biên dịch, 154-155
các yếu tố cần xem xét, 156
kiểm soát, 136
đị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
kiểm soát 136
định nghĩa 124, 136, 157
Hồ sơ dự án 451-461
Lưu ý trong ví dụ bên tay 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 chỉ mục không chấp nhận 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 tay trái. Tại sao tham chiếu trang 123 lại không nằm giữa các mục con? Chủ đề phụ trên trang 123 là gì?
Tôi rất trân trọng ý kiến, phản ứng và đóng góp phê bình 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.
Tác phẩm này được cấp phép dưới một Giấy phép Quốc tế Creative Commons Attribution 4.0. - Tìm kiếm các mục tăng cao. 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 sao chép ra thành mục chính.