Dự án TheGoodDocsProject

Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Phần Google Tài liệu.

Tóm tắt dự án

Tổ chức nguồn mở:

TheGoodDocsProject

Người viết nội dung kỹ thuật:

Phạm vi rộng

Tên dự án:

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

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

Thời gian 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 cách lập kế hoạch cho hướng dẫn cấu trúc thông tin cho Dự án Good Tài liệu. Mẫu này được chuẩn bị trong quá trình gửi Phần Tài liệu năm 2020 của Google. Tài liệu này phác thảo trường hợp sử dụng của tài liệu hướng dẫn được đề xuất và phác thảo kế hoạch cấu trúc của tài liệu hướng dẫn đó để lập kế hoạch.

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

Trong một thế giới hoàn hảo, tài liệu được thiết kế bằng cách bắt đầu với chiến lược nội dung, trong đó sử dụng mục tiêu kinh doanh để xác định mục tiêu của tài liệu. Sau đó, chiến lược nội dung được dùng để tạo IA, nhằm xác định bố cục và cấu trúc của tài liệu. Tại đó, người dùng có thể chọn chuỗi công cụ và viết nội dung. Trên thực tế, 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 đủ để có thể 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 giúp người viết không chuyên nghiệp xây dựng một IA đủ để xác định mẫu họ nên sử dụng. Quá trình này phải đủ đơn giản để một người bình thường hoàn thành vào buổi chiều và nên ưu tiên hành động hơn là giáo dục. Tốt nhất là phần 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 những khái niệm đó trong mối liên hệ với dự án của họ và sử dụng kết quả thu được để chuyển sang khái niệm tiếp theo.

Để chuẩn bị cho dự án này, chúng tôi cần thực hiện một số cập nhật đối với dự án README để độc giả nắm được cách bắt đầu sử dụng Dự án Good Tài liệu và có thể sử dụng hướng dẫn IA một cách hiệu quả để định hướng lựa chọn mẫu.

Đối tượng chính

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

Các 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 của IA. Việc này có thể giúp chúng tôi xác định cấu trúc của hướng dẫn này nhằm phục vụ những độc giả đó hiệu quả nhất.

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 Good Tài liệu để sắp xếp tài liệu của mình, nhưng không biết phải bắt đầu từ đâu. Họ tuân theo README để hiểu cách bắt đầu sử dụng các mẫu, sau đó làm theo Information Architecture Guide để phát triển chiến lược nội dung và lên kế hoạch về giao diện của bộ tài liệu.

Đề xuất

Cập nhật tệp 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 rõ ràng đầu tiên. 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 IA mới. Hướng dẫn đó sẽ mời độc giả cân nhắc về đối tượng, giản đồ nội dung, ma trận người dùng/tác vụ, v.v. mà không tạo quá nhiều gánh nặng cho người đọc để phải tìm hiểu/hiểu những thứ đó theo nghĩa học thuật. Sau khi hoàn thành nhiệm vụ này, người đọc sẽ hiểu về những mẫu cần thiết và cách để hoàn thành chúng một cách hiệu quả nhất.

Tìm hiểu

Để hỗ trợ cho việc nghiên cứu, tôi sẽ dựa khá nhiề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ó đã tạo thành cơ sở cho nhiều nội dung tôi đã viết và sẽ sử dụng, nhưng cũng vì nó rất dễ dàng để những người mới biết IA có thể hứng thú và đọc nếu họ có hứng thú. Theo nghĩa đó, đó cũng là một loại thuốc cổng vào IA.

Điều khoản dịch vụ nháp

README:

-- Giới thiệu về dự án tốt trong Tài liệu |_ Ai nên sử dụng mẫu |_ Cách thức hoạt động của các mẫu |_ Đóng góp vào dự án -- Các mẫu |_ Danh sách tất cả các mẫu hiện có |_ Chọn mẫu nên sử dụng |_ Trước khi bắt đầu -- Trước khi bắt đầu soạn thảo |_ Ai đọc tài liệu? |_ Tại sao họ đọc tài liệu? |_ Viết dành cho độc giả

Hướng dẫn dành cho IA:

-- Giới thiệu |_ IA là gì? |_ Tại sao tôi nên quan tâm? – Xác định mớ lộn xộn -- Nêu rõ ý định của bạn -- Thực tế trên mặ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