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