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ở:
- Kolibri
- Người viết nội dung kỹ thuật:
- Danielle V
- Tên dự án:
- Quy trình làm việc của nội dung Kolibri
- Thời lượng dự án:
- Lâu dài (5 tháng)
Mô tả dự án
Chúng tôi tạo ra đề xuất dưới đây bằng cách tiến hành nghiên cứu và trao đổi với những người cố vấn của Kolibri. Việc trò chuyện với các người cố vấn đã giúp tôi phát triển chân dung của người dùng mà tôi đã thảo luận dưới đây. Ngoài ra, việc thảo luận đã giúp tôi nghĩ ra ý tưởng liên quan đến kho lưu trữ hướng dẫn/trang đích để người dùng có thể lựa chọn xem hướng dẫn nào phù hợp với nhu cầu của họ.
Tổng quan
Đề xuất này đưa ra giải pháp hướng dẫn các hành trình khác nhau của người dùng mà một cá nhân có thể nhập nội dung từ máy tính vào Kolibri Studio, sau đó từ Kolibri Studio vào Kolibri. Tôi đề xuất tạo một kho lưu trữ trung tâm gồm các bài hướng dẫn. Người dùng sẽ truy cập vào những hướng dẫn này thông qua trang đích. Trang đích sẽ cung cấp một bảng với các đường liên kết đến từng hướng dẫn về quy trình làm việc và sẽ cho biết kiểu người dùng mà hướng dẫn này có thể mang lại lợi ích. Bằng cách này, nội dung hướng dẫn sẽ được cá nhân hoá nhiều hơn theo nhu cầu và khả năng của người dùng. Một quy trình công việc (ví dụ: INSTALL- ENTER) được minh hoạ bằng nhiều bài học. Mỗi bài học đều có video. Video giới thiệu một phần nhỏ của quy trình làm việc và minh hoạ các khái niệm riêng về cách những quy trình này kết nối các ứng dụng của Kolibri.
Mục tiêu chính
Tạo trang đích hướng dẫn giúp người dùng quyết định quy trình làm việc nào phù hợp nhất với nhu cầu của họ. Trang đích này sẽ được lưu trữ trên nền tảng Đọc tài liệu.
Tạo các bài học riêng cho các thành phần của từng quy trình làm việc và bổ sung các bài học khó bằng các bài tập.
Tạo video tương tác cho từng quy trình làm việc.
Công cụ dự án
Công việc sẽ được thực hiện bằng phần mềm ghi màn hình. Tôi có kinh nghiệm về Camtasia, nhưng cũng đã từng làm việc với các phần mềm miễn phí và phần mềm ít tốn kém hơn. Video mẫu được liên kết ở đây (https://youtu.be/DkMP_VdGslU) được tạo bằng Flashback của Blueberry Software mà tôi hiện có giấy phép. Tôi sẽ tạo phụ đề bằng YouTube. Các trang hướng dẫn sẽ được lưu trữ trên trang web Đọc tài liệu của Kolibri. Bản nháp sẽ được hoàn tất trong Google Tài liệu và tôi có thể giúp chuyển đổi tệp văn bản thành Markdown hoặc reStructureText cho sản phẩm sau cùng.
Mốc thời gian
Dự án này sẽ tuân thủ các hướng dẫn dài hạn của dự án (tổng cộng 26 tuần, từ ngày 2 tháng 9 năm 2019 đến ngày 28 tháng 2 năm 2020). Tôi sẽ dành khoảng 10 giờ mỗi tuần để hoàn thành các mục tiêu được nêu dưới đây. Ngoài những mục tiêu này, tôi sẽ tham gia các cuộc họp và các buổi trao đổi về cố vấn trong thời gian này nếu cần. Tôi sẽ làm việc với các cố vấn để xác định thời điểm phù hợp nhất cho việc này. Tiến trình thường được chia thành các giai đoạn trong bốn tuần, trong đó tôi sẽ tạo nhiều video, trang hướng dẫn và bài tập.
Tuần 1 và 2
Mục tiêu:
- Thiết lập thiết bị cá nhân với những trang web hoặc tài khoản cần thiết để truy cập vào thông tin.
- Bắt đầu phát triển cấu trúc và khung dây chi tiết hơn cho trang đích.
- Thảo luận với người cố vấn về phong cách cho video, cũng như phát triển một mẫu màn hình mở video, mọi nhạc đệm cho tiêu đề và màn hình kết thúc và các thông tin bổ sung nên được đưa vào.
- Xem lại tài liệu và cấu trúc tài liệu hiện tại để trích xuất các đường liên kết nhằm sử dụng trong các tài nguyên và tài liệu tham khảo hướng dẫn khác.
Tuần 3 đến 6 (Hướng dẫn cho người mới bắt đầu)
Mục tiêu:
- Phát triển nội dung và bài học ban đầu cho quy trình CÀI ĐẶT-NHẬP/Cấp độ 1. Tạo video cho quá trình tải xuống, cài đặt, định cấu hình và nhập. Vì các hàm INSTALL-ENTER là cơ sở cho nhiều quy trình công việc khác và cũng là hàm phổ biến nhất, nên bạn sẽ dành nhiều thời gian để hoàn thiện các hướng dẫn và bài học này.
- Tập trung vào các loại vị trí NHẬP và phát triển hình ảnh minh hoạ cho người dùng biết nơi họ có thể mua nội dung (kênh công khai có trong Kolibri Studio) cho trang đích.
- Phát triển các video và nội dung bổ sung để mở rộng tính năng INSTALL-INSTALL (CẬP NHẬT kênh). Những nội dung mở rộng này cũng có thể ở dạng tài nguyên bổ sung hoặc đường liên kết đến tài liệu hiện có.
- Làm việc với phụ đề cho bất kỳ video nào.
- “Thử nghiệm” video và xin ý kiến phản hồi từ mọi tài nguyên hiện có về khả năng hữu dụng. Trong đó, chúng tôi xem lại mẫu video và củng cố mẫu cho các video trong tương lai.
Tuần 7 đến 10 (Cấp 2 – Người tải nội dung lên)
Mục tiêu:
- Tập trung vào các bài học và video về quy trình làm việc cho cá tính của Người tải lên trong Studio.
- Hoàn tất tài liệu và bài học cho tính năng TẢI LÊN-XUẤT BẢN NHẬP KHẨU.
- Phát triển phụ đề cho bất kỳ video nào.
Tuần 11 đến tuần 14 (Cấp 3 – "Người phối lại" và Người chỉnh sửa nội dung)
Mục tiêu:
- Tập trung vào các quy trình làm việc sau đây và tạo nội dung hướng dẫn/bài học: UPLOAD-EDIT-PUBLISH-UPDATE và EDIT-PUBLISH-UPDATE.
- Phát triển phụ đề cho video.
Tuần 15 đến 18
Mục tiêu:
- Như được truyền đạt trong quá trình nghiên cứu đề xuất này, quy trình làm việc liên quan đến Nồi cơm điện có mức độ ưu tiên thấp hơn (loại CHEFDEV). Tuỳ thuộc vào thời gian và lịch biểu, tôi có thể dành thời gian này để tạo hướng dẫn tổng quan tham khảo tài liệu hiện có về Nồi cơm điện.
Tuần 19 đến 22
Mục tiêu:
- Hãy đánh giá mọi khoảng trống tại thời điểm này và kiểm tra tiến trình hiện tại của tất cả các hướng dẫn.
- Hoàn thiện trang đích và bắt đầu liên kết các video với nhau.
- Chuyển đổi bản nháp trang thực hiện trong Google Tài liệu thành Markdown hoặc restructureText, như đã thảo luận với người cố vấn.
Tuần 23 đến 25
Mục tiêu:
- Tuỳ theo thời gian, hãy hoàn thành mọi công việc cuối cùng trên các hướng dẫn nâng cao, có mức độ ưu tiên thấp.
- Phút cuối Đọc phần chỉnh sửa trang Tài liệu, kiểm tra tệp, kiểm tra ngữ pháp/chính tả.
- Đảm bảo chất lượng cho mọi đường liên kết trong video hoặc trên các trang khác.
Tuần 26
Tuần cuối dành cho các dự án dài hạn. Tôi sẽ làm việc với người cố vấn để hoàn thiện các sản phẩm của dự án và hoàn thành mọi tài liệu cuối cùng, bắt buộc của Google.
Thành phần hướng dẫn
Trang đích hướng dẫn
Người dùng sẽ truy cập vào trang đích hướng dẫn trên trang web Đọc tài liệu của Kolibri. Trang này sẽ trình bày ngắn gọn về các hướng dẫn được cung cấp cho quy trình liên quan đến nội dung. Mục đích của trang này là để cung cấp tổng quan ngắn gọn về hệ sinh thái Kolibri cũng như cung cấp hình ảnh về các quy trình làm việc khác nhau. Nhờ đó, người dùng có thể xem loại quy trình làm việc phù hợp với nhu cầu của họ, cả về mặt kỹ thuật và chương trình học của tổ chức. Người dùng sẽ hiểu rõ hơn về các tuỳ chọn dành cho họ trong Kolibri và Kolibri Studio.
Trang hướng dẫn và bài học
Mỗi trang chủ của hướng dẫn sẽ có phần giới thiệu về hướng dẫn (bao gồm nhiều bài học), theo sau là một số mục tiêu của người dùng. Hướng dẫn minh hoạ toàn bộ quy trình làm việc và bao gồm các bài học riêng lẻ. Mỗi bài học sẽ có một video. Các video sẽ đề cập đến một phần riêng của ý tưởng tổng thể. Mỗi bài học sẽ được lưu trên một trang riêng trong trang mẹ của quy trình hướng dẫn. Các trang bài học sẽ có các nút cho phép người dùng điều hướng đến bài học trước hoặc bài học tiếp theo trong phần hướng dẫn. Các khái niệm rất phức tạp có thể bao gồm cả hoạt động thực hành.
Video và cấu trúc
Video sẽ nêu ra một khái niệm duy nhất. Video sẽ đưa ra hướng dẫn trong khi thực hiện thao tác đó trên màn hình. Bạn có thể xem video ví dụ tại đây: https://youtu.be/DkMP_VdGslU. Video ví dụ này hướng dẫn cách sử dụng trình hướng dẫn Thiết lập tiện ích.
Video này sử dụng chú thích và con trỏ được làm nổi bật để hướng dẫn người dùng thực hiện các bước của khái niệm này. Video sẽ được lưu trữ trên YouTube. Nếu lưu trữ trên YouTube, phụ đề sẽ được tạo tự động. Sau đó, tôi sẽ chỉnh sửa chính tả, ngữ pháp và dấu câu của phụ đề. Sau đó, bạn có thể xuất các phụ đề đó ra bản dịch bằng tiếng Amara hoặc một công cụ dịch khác.
Các video sẽ có màn hình tiêu đề nhất quán và tôi dự định sẽ thảo luận với các cố vấn trong một vài tuần đầu tiên. Tôi cũng sẽ sử dụng kiểu chú thích nhất quán (mũi tên, phần đánh dấu con trỏ, hộp) sẽ được quyết định cùng với các cố vấn trong một vài tuần đầu tiên.
Cấu trúc mẫu
Quy trình làm việc đơn giản nhất, INSTALL-ENTER, là một hướng dẫn đầy đủ. Trong hướng dẫn đó, bạn có thể xem xét hai bài học kèm theo video:
- Tải xuống, cài đặt và thiết lập cơ sở Kolibri của bạn
- Nhập nội dung trong Kolibri Studio – Lưu ý rằng các quy trình làm việc khác sẽ tham chiếu đến video này
Hướng dẫn nâng cao hơn yêu cầu nhiều bài học phụ có nhiều video. Quy trình TẢI LÊN-CHỈNH SỬA-XUẤT BẢN-UPDATE tuân theo cấu trúc bên dưới.
Bài 1 – Tải nội dung lên và tạo kênh trong Kolibri Studio
Mục tiêu của người dùng: Vào cuối bài học này, bạn sẽ biết cách hoàn thành các hành động sau:
- Tạo kênh trong Kolibri Studio để sử dụng trong Kolibri. Bạn sẽ biết cách sử dụng mã bí mật của kênh để nhập kênh nội dung vào Kolibri.
- Bạn có thể tạo kênh bằng cách nhập nội dung từ các kênh công khai hiện có trong Thư viện của Studio.
- Tạo kênh bằng cách tải nội dung lên từ máy tính.
Video của bài học phụ:
- Bài học phụ 1 – Tạo kênh của riêng bạn trên Kolibri Studio và nhập nội dung từ các kênh công khai hiện có (Học viện Khánh, PHET, v.v.): Video 1 – Kênh nội dung công khai (xem kênh CÔNG KHAI trên Kolibri Studio) Video 2 – Tạo kênh Video 3 – Nhập nội dung từ các kênh hiện có Video 4 – Xuất bản kênh và lấy mã bí mật Video 5 – Nhập kênh của bạn vào Kolibri bằng mã bí mật
- Bài học phụ 2—Tải lên kênh nội dung tài liệu của tôi: Video 1 – Tải tệp lên từ Tài liệu của tôi Video 2—Tạo bài tập của riêng bạn
Bài 2 – Chỉnh sửa nâng cao các kênh trong Kolibri Studio
Mục tiêu của người dùng: Vào cuối bài học này, bạn sẽ biết cách hoàn thành các hành động sau:
- Chỉnh sửa kênh nội dung trong Kolibri Studio
- Quản lý kênh nội dung trong Kolibri Studio
Video của bài học phụ:
- Bài học phụ 1 – Chỉnh sửa nội dung bằng cách thêm bài tập, sắp xếp lại cấu trúc thư mục và các tuỳ chọn cộng tác (1 video)
- Bài học phụ 2 – Sử dụng các chức năng khác như xoá/di chuyển nội dung (1 video)
Bài 3 – Xuất bản kênh Kolibri Studio để sử dụng trong Kolibri và cập nhật kênh
Mục tiêu của người dùng: Vào cuối bài học này, bạn sẽ biết cách hoàn thành các hành động sau:
- Xuất bản một kênh trong Kolibri Studio và xuất bản lại sau khi thêm nội dung mới
- Cập nhật kênh
- Lấy mã thông báo kênh để nhập vào Kolibri (thông qua đường liên kết đến video trước trong Bài học 1 đề cập đến thao tác này)
Video của bài học phụ:
Bài học phụ 1 – Xuất bản nội dung cập nhật lên một kênh
Video 1: Xuất bản lại kênh Video 2: Cập nhật kênh trên Kolibri sau khi thêm nội dung bổ sung