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 tài liệu của Google.
Tóm tắt dự án
- Tổ chức nguồn mở:
- CERN-HSF
- Tác giả kỹ thuật:
- LuckInTheRain
- Tên dự án:
- Tài liệu về ROOT: Phân tích, tái cấu trúc và viết lại
- Độ dài dự án:
- Chạy trong thời gian dài (5 tháng)
Mô tả dự án
Dự án này bao gồm 4 giai đoạn:
1.) Phân tích tài liệu về ROOT hiện tại
Tài liệu ROOT hoàn chỉnh (trang web, hướng dẫn sử 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, việc chuẩn bị dành riêng cho nhóm mục tiêu và khả năng hiểu được. Mục đích là tạo ra một khái niệm về quản lý thông tin, một ma trận để cấu trúc và một 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 cho phần mềm viết với nhóm ROOT
DITA (Darwin Information Typing Architecture), 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 sắp xếp 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 như "khái niệm", "tác vụ" và "tài liệu tham khảo" để viết tài liệu phần mềm.
3.) Điều chỉnh 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 các 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 phần tử 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. Vì thông tin có sẵn rất phong phú, nên bạn cũng phải thiết lập một 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 rõ cách sử dụng ROOT cho nhu cầu của họ. Ngoài ra, chúng tôi còn cung cấp một phần giới thiệu ngắn gọn không theo hướng vật lý.
4.) Viết lại tài liệu về ROOT
Các phần chính của tài liệu, đặc biệt là Hướng dẫn sử dụng, được viết lại theo phương pháp DITA. Các quy tắc về cấu trúc và cách viết được ghi lại trong Hướng dẫn về quy tắc để đả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 ROOT trong tương lai.
Tiến trình dự kiến (5 tháng):
Giai đoạn 1: Phân tích tài liệu ROOT hiện tại: 3 tuần.
Giai đoạn 2: Xác định phương pháp để sắp xếp tài liệu viết phần mềm với nhóm ROOT: 2 tuần.
Giai đoạn 3: Điều chỉnh cấu trúc và sắp xếp lại tài liệu ROOT: 4 tuần.
Giai đoạn 4: Viết lại tài liệu ROOT: 11 tuần.