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ở:
- moja global
- Người viết nội dung kỹ thuật:
- Anthony
- Tên dự án:
- Tài liệu về mã công cụ báo cáo
- Thời lượng dự án:
- Thời hạn tiêu chuẩn (3 tháng)
Mô tả dự án
Được trao cơ hội ghi lại Công cụ báo cáo cho tổ chức Moja Global, tôi đề xuất phát triển 6 loại tài liệu mà các đối tượng khác nhau sẽ sử dụng để đạt được các mục đích khác nhau. Dưới đây là thông tin tóm tắt về các tính năng này:
1)Hướng dẫn thiết lập môi trường
1.1) Đối tượng mục tiêu: Kỹ sư hệ thống
1.2) Mục tiêuGiúp Kỹ sư hệ thống thiết lập môi trường xây dựng và thực thi cục bộ cho Công cụ báo cáo.
1.3) Định dạng Một bài viết hướng dẫn quy định tập hợp các bước tuần tự mà Kỹ sư hệ thống phải thực hiện để thiết lập môi trường thuận lợi cho việc xây dựng và chạy Công cụ báo cáo.
2)Hướng dẫn tạo bản dựng
2.1) Đối tượng mục tiêu: Kỹ sư hệ thống
2.2) Mục tiêu Giúp Kỹ sư hệ thống xây dựng các thành phần của Công cụ báo cáo từ mã nguồn
2.3) Định dạng Bài viết hướng dẫn quy định tập hợp các bước tuần tự mà Kỹ sư hệ thống phải thực hiện để lấy và biên dịch Mã nguồn của Công cụ báo cáo.
3)Hướng dẫn cài đặt
3.1) Đối tượng mục tiêu: Kỹ sư hệ thống
3.2) Mục tiêu Giúp Kỹ sư hệ thống cài đặt các thành phần Công cụ báo cáo mới tạo
3.3) Định dạng Một bài viết hướng dẫn quy định tập hợp các bước tuần tự mà Kỹ sư hệ thống phải thực hiện để triển khai Công cụ báo cáo trên một môi trường mới thiết lập.
4)Hướng dẫn vận hành
4.1) Trình tích hợp hệ thống đối tượng mục tiêu
4.2) Mục tiêu Giúp Kỹ sư hệ thống chạy một phiên bản Công cụ báo cáo mới cài đặt
4.3) Định dạng Một bài viết hướng dẫn quy định tập hợp các bước tuần tự mà Nhà tích hợp hệ thống phải thực hiện để tải lên và xử lý Cơ sở dữ liệu đầu ra Flux trên một thực thể Công cụ báo cáo đang chạy.
Hướng dẫn vận hành Tạo và xử lý Cơ sở dữ liệu đầu ra Flux trong Công cụ báo cáo
5)Hướng dẫn sử dụng
5.1) Đối tượng mục tiêu Người dùng cuối
5.2) Mục tiêu Giúp Người dùng cuối hiểu được các tính năng được nhúng trong Công cụ báo cáo và cách sử dụng các tính năng này.
5.3) Định dạng Một bài viết hướng dẫn quy định tập hợp các bước tuần tự mà Người dùng cuối phải thực hiện để sử dụng đúng cách các chức năng của Công cụ báo cáo.
6) Hướng dẫn phát triển
6.1) Đối tượng mục tiêu: Lập trình viên
6.2) Mục tiêu Giúp Người dùng cuối hiểu rõ các tính năng được nhúng trong Công cụ báo cáo và cách sử dụng các tính năng này.
6.3) Định dạng Bài viết tham khảo mô tả:
Và một hướng dẫn ngắn mô tả cách điều chỉnh mã cho phù hợp với trường hợp cụ thể của người dùng