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ở:
- CERN-HSF
- Người viết nội dung kỹ thuật:
- LuckInTheRain
- Tên dự án:
- Tài liệu ROOT: Phân tích, tái cấu trúc và viết lại
- Thời lượng dự án:
- Lâu dài (5 tháng)
Mô tả dự án
Dự án này gồm 4 giai đoạn:
1.) Phân tích tài liệu ROOT hiện tại
Tài liệu ROOT hoàn chỉnh (trang web, hướng dẫn người dùng, tài liệu tham khảo C++, hướng dẫn, v.v.) được phân tích và kiểm tra theo các tiêu chí sau: cấu trúc, mô-đun hoá, chuẩn hoá, cơ chế truy cập, tính nhất quán, loại thông tin được sử dụng, chuẩn bị và mức độ hiểu cụ thể của nhóm mục tiêu. Mục đích là để tạo ra khái niệm về quản lý thông tin và ma trận để xây dựng cấu trúc và hướng dẫn chuẩn hoá nội dung.
2.) Xác định phương pháp xây dựng cấu trúc tài liệu phần mềm viết với nhóm ROOT
DITA (Kiến trúc nhập thông tin Darwin), một tiêu chuẩn OASIS cho tài liệu phần mềm (https://www.oasis-open.org/committees/dita/) được trình bày cho nhóm ROOT. Trọng tâm chính là tìm hiểu cách định cấu trúc nội dung dành riêng cho phần mềm và cách sử dụng các loại thông tin cơ bản dưới dạng “khái niệm”, “nhiệm vụ” và “tham chiếu” để viết tài liệu phần mềm.
3.) Tái cấu trúc và sắp xếp lại tài liệu về ROOT
Dựa trên kết quả của hai bước đầu tiên, tài liệu ROOT được tái cấu trúc và mô-đun hoá theo nhóm mục tiêu, vai trò và trường hợp sử dụng, đồng thời nội dung được chỉ định cho các thành phần tương ứng (trang web, hướng dẫn sử dụng, tài liệu tham khảo C++, hướng dẫn, v.v.) và loại nội dung. Do thông tin có sẵn rất rộng nên bạn cũng phải thiết lập cấu trúc tham chiếu nhất quán. Mục đích là để cung cấp thông tin tổng quan toàn diện và cho người dùng thấy những cách thức rõ ràng để họ có thể sử dụng ROOT theo nhu cầu của mình. Ngoài ra, còn có một phần giới thiệu ngắn gọn theo định hướng phi vật lý.
4.) Viết lại tài liệu ROOT
Các phần chính của tài liệu, đặc biệt là Hướng dẫn cho người dùng, được viết lại theo phương pháp DITA. Các quy tắc kết cấu và viết được ghi lại trong Hướng dẫn về văn phong để đảm bảo tính nhất quán trong các tài liệu sau này. Mục tiêu là giúp nhóm ROOT tự mở rộng và duy trì tài liệu về ROOT trong tương lai.
Lịch biểu thời gian dự kiến (5 tháng):
Giai đoạn 1: Phân tích tài liệu về ROOT hiện tại: 3 tuần.
Giai đoạn 2: Xác định phương pháp xây dựng cấu trúc tài liệu viết phần mềm với nhóm ROOT: 2 tuần.
Giai đoạn 3: Tái cấu trúc và tổ chức lại tài liệu ROOT: 4 tuần.
Giai đoạn 4: Viết lại tài liệu về ROOT: 11 tuần.