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ở:
- Moja toàn cầu
- 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 gian tiêu chuẩn (3 tháng)
Mô tả dự án
Với cơ hội lập tài liệu về Công cụ báo cáo cho tổ chức Moja Global, tôi dự định 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. Những điều này được tóm tắt dưới đây:
1) Hướng dẫn thiết lập môi trường
1.1) Kỹ sư hệ thống đối tượng mục tiêu
1.2) Mục tiêu Kỹ sư hệ thống trợ giúp 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 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 hỗ trợ việc xây dựng và chạy Công cụ báo cáo.
2) Hướng dẫn xây dựng
2.1) Kỹ sư hệ thống đối tượng mục tiêu
2.2) Mục tiêu Kỹ sư hệ thống trợ giúp 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 soạn Mã nguồn của Công cụ báo cáo.
3) Hướng dẫn cài đặt
3.1) Kỹ sư hệ thống đối tượng mục tiêu
3.2) Mục tiêu Kỹ sư hệ thống giúp cài đặt các thành phần mới của Công cụ báo cáo
3.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 để triển khai Công cụ báo cáo trong môi trường thiết lập mới.
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 Kỹ sư hệ thống trợ giúp chạy một thực thể Công cụ báo cáo mới được cài đặt
4.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à 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 thực thể Công cụ báo cáo đang chạy.
Hướng dẫn vận hành Giới thiệu 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 tính năng khác nhau đượ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 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 chức năng của Công cụ báo cáo.
6) Hướng dẫn phát triển
6.1) Lập trình viên đối tượng mục tiêu
6.2) Mục tiêu Giúp Người dùng cuối hiểu các tính năng khác nhau đượ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ả: a) các thành phần thiết kế chính tạo nên công cụ b) phân rã chức năng của các thành phần trên c) thành phần thực thi của các thành phần đã phân rã theo chức năng d) mã nguồn / tổ chức thư viện của công cụ e) tầm nhìn dài hạn và định hướng cải tiến liên tục f) lĩnh vực logic tiếp theo để cải thiện
Và một hướng dẫn ngắn mô tả cách mã có thể được điều chỉnh theo tình huống cụ thể của người dùng