Dự án TheGoodDocsProject

Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.

Tóm tắt dự án

Tổ chức nguồn mở:

TheGoodDocsProject

Tác giả kỹ thuật:

Loquacity

Tên dự án:

Hướng dẫn về cấu trúc thông tin

Thời lượng dự án:

Thời hạn tiêu chuẩn (3 tháng)

Mô tả dự án

Kế hoạch hướng dẫn về cấu trúc thông tin

Tài liệu này trình bày việc lập kế hoạch cho hướng dẫn về kiến trúc thông tin cho Dự án tài liệu đáng tin cậy. Tài liệu này được chuẩn bị trong khuôn khổ chương trình Google Season of Docs 2020. Tài liệu này trình bày trường hợp sử dụng cho hướng dẫn được đề xuất và phác thảo kế hoạch về cấu trúc của hướng dẫn đó cho mục đích lập kế hoạch.

Kiến trúc thông tin (IA) liên quan đến cách sắp xếp nội dung. Cấu trúc nội dung đề cập đến cấu trúc của nội dung mà không xác định kiểu hoặc từ được sử dụng trong chính nội dung đó. Ví dụ: một kế hoạch IA sẽ xem xét độc giả là ai, cách họ tiếp cận nội dung và môi trường mà họ đang đọc. Sau đó, công cụ này sẽ xem xét một cấu trúc phù hợp cho nội dung để đáp ứng tốt nhất các yêu cầu của người đọc.

Trong trường hợp lý tưởng, tài liệu được thiết kế bằng cách bắt đầu từ một chiến lược nội dung, trong đó sử dụng các mục tiêu kinh doanh để xác định mục tiêu của tài liệu. Chiến lược nội dung sau đó sẽ được dùng để tạo IA, giúp xác định bố cục và cấu trúc của tài liệu. Từ đó, bạn có thể chọn chuỗi công cụ và viết nội dung. Thực tế của hầu hết các dự án nguồn mở là chiến lược nội dung đơn giản như "viết một số tài liệu để mọi người biết cách sử dụng dự án này", nhưng ngay cả chiến lược đơn giản đó cũng đủ để xác định một IA hiệu quả.

Mục đích của hướng dẫn này là cung cấp một công cụ đơn giản để những người viết không chuyên có thể phát triển một IA đủ để xác định mẫu nào họ nên sử dụng. Quy trình này phải đủ đơn giản để một người bình thường có thể hoàn thành trong một buổi chiều và phải ưu tiên hành động hơn là kiến thức. Lý tưởng nhất là bài học này sẽ giới thiệu các khái niệm một cách ngắn gọn, hướng dẫn người đọc xem xét các khái niệm đó có liên quan đến dự án của riêng họ hay không, sau đó sử dụng kết quả thu được để chuyển sang khái niệm tiếp theo.

Là một bản dựng cho dự án này, bạn cần cập nhật một số nội dung vào tệp README của dự án để người đọc hiểu cách bắt đầu với Dự án tài liệu chất lượng và có thể sử dụng hướng dẫn về IA một cách hiệu quả để lựa chọn mẫu.

Đối tượng chính

Tất cả những người muốn sử dụng các mẫu của Dự án Tài liệu chất lượng để tạo tài liệu cho dự án của họ

Trường hợp sử dụng: Phần này được thiết kế để khám phá cách độc giả tiếp cận Hướng dẫn về AI. Điều này có thể giúp chúng tôi xác định cách sắp xếp hướng dẫn để phục vụ tốt nhất cho những độc giả đó.

Tình huống: Một người đang thực hiện một dự án nguồn mở có ít hoặc không có tài liệu, hoặc một bộ tài liệu được sắp xếp hoặc viết sai cách. Họ quyết định sử dụng Dự án Tài liệu tốt để sắp xếp tài liệu của mình, nhưng không biết nên bắt đầu từ đâu. Họ làm theo phần README để nắm được cách bắt đầu sử dụng các mẫu và làm theo Information Architecture Guide để phát triển chiến lược nội dung cũng như lên kế hoạch cho bộ tài liệu của mình.

Đề xuất

Hãy cập nhật phần README để hướng dẫn rõ ràng hơn cho người đọc mới về dự án, bao gồm cả các bước đầu tiên rõ ràng. Một trong những bước đầu tiên đó là đọc và trả lời các câu hỏi trong Hướng dẫn mới về AI. Hướng dẫn đó sẽ mời người đọc xem xét đối tượng, giản đồ nội dung, ma trận người dùng/tác vụ, v.v. mà không gây quá nhiều gánh nặng cho người đọc trong việc tìm hiểu/hiểu những khái niệm đó theo nghĩa hàn lâm. Sau khi hoàn tất nhiệm vụ này, người đọc sẽ nắm được các mẫu cần có và cách hoàn thành mẫu sao cho hiệu quả nhất.

Tìm hiểu

Để hỗ trợ cho quá trình nghiên cứu, tôi sẽ dựa chủ yếu vào cuốn sách của Abby Covert (http://www.howtomakesenseofanymess.com/), một phần vì tôi rất quen thuộc với nó và nó đã định hình nền tảng của nhiều nội dung tôi đã viết và sẽ sử dụng, nhưng cũng vì những người mới sử dụng IA có thể dễ dàng nắm bắt và đọc nếu họ có hứng thú khác. Theo nghĩa đó, đó có thể là một loại thuốc cổng vào IA.

Bản nháp mục lục

README:

-- Giới thiệu về Dự án tài liệu chất lượng |_ Những ai nên sử dụng các mẫu này |_ Cách hoạt động của các mẫu này |_ Đóng góp cho dự án -- Các mẫu |_ Danh sách tất cả mẫu hiện tại |_ Cách chọn mẫu để sử dụng |_ Trước khi bắt đầu -- Trước khi bắt đầu viết |_ Ai đọc tài liệu? |_ Tại sao họ đọc tài liệu? |_ Viết cho độc giả

Hướng dẫn về IA:

-- Giới thiệu |_ IA là gì? |_ Tại sao tôi nên quan tâm? – Xác định vấn đề rối rắm – Trình bày ý định của bạn – Đối mặt với thực tế – Chọn một hướng – Đo khoảng cách – Chơi với cấu trúc – Chuẩn bị điều chỉnh