Project Kolibri

Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.

Ringkasan project

Organisasi open source:

Kolibri

Penulis teknis:

Danielle V

Nama project:

Alur Kerja Konten Kolibri

Durasi project:

Berjalan lama (5 bulan)

Project description

Proposal di bawah ini dibuat dengan melakukan riset dan berbicara dengan mentor Kolibri. Percakapan saya dengan mentor membantu saya mengembangkan persona pengguna yang saya bahas di bawah. Selain itu, diskusi saya membantu saya mendapatkan ide tentang repositori/halaman landing tutorial sehingga pengguna memiliki pilihan terkait tutorial yang ingin mereka lihat untuk kebutuhan mereka.

Ringkasan

Proposal ini menyajikan solusi untuk memandu berbagai perjalanan pengguna, sehingga seseorang dapat mengimpor konten dari komputernya ke Kolibri Studio, lalu dari Kolibri Studio ke Kolibri. Saya mengusulkan untuk membuat repositori tutorial terpusat. Pengguna akan mengakses tutorial ini melalui halaman landing. Halaman landing akan menyediakan tabel dengan link ke setiap tutorial alur kerja dan akan menunjukkan jenis pengguna yang dapat diuntungkan oleh tutorial tersebut. Dengan cara ini, tutorial akan lebih dipersonalisasi sesuai kebutuhan dan kemampuan pengguna. Alur kerja (misalnya, INSTALL- IMPORT) ditunjukkan oleh beberapa pelajaran. Setiap pelajaran berisi video. Video menunjukkan sebagian kecil alur kerja dan menunjukkan konsep individual tentang cara alur kerja ini menghubungkan aplikasi Kolibri.

Sasaran Utama

1. Buat halaman landing tutorial yang membantu pengguna memutuskan alur kerja yang paling sesuai dengan kebutuhan mereka. Halaman landing ini akan dihosting di platform Read the Docs.

2. Buat setiap pelajaran untuk komponen setiap alur kerja dan lengkapi pelajaran yang sulit dengan latihan.

3. Buat video interaktif untuk setiap alur kerja.

Alat Proyek

Pekerjaan akan dilakukan menggunakan software screencasting. Saya memiliki pengalaman dengan Camtasia, tetapi saya juga telah bekerja dengan software dan software gratis yang berbiaya lebih rendah. Contoh video yang ditautkan di sini (https://youtu.be/DkMP_VdGslU) dibuat dengan Flashback oleh Blueberry Software, yang lisensinya saat ini saya miliki. Saya akan membuat subtitel menggunakan YouTube. Halaman tutorial akan dihosting di situs Read the Docs Kolibri. Draf pekerjaan akan diselesaikan di Google Dokumen dan saya dapat membantu mengonversi file teks ke Markdown atau reStructuredText untuk produk akhir.

Linimasa

Proyek ini akan mengikuti pedoman proyek jangka panjang (total 26 minggu, dari 9/2/2019-2/28/2020). Saya akan menghabiskan sekitar 10 jam seminggu untuk menyelesaikan sasaran yang diuraikan di bawah. Selain tujuan ini, saya akan berpartisipasi dalam pertemuan dan komunikasi mentor selama waktu ini, sesuai kebutuhan. Saya akan bekerja sama dengan mentor untuk menentukan waktu terbaik untuk ini. Linimasa ini umumnya dibagi menjadi beberapa bagian selama empat minggu, di mana saya akan membuat beberapa video, halaman tutorial, dan latihan.

Catatan: Linimasa ini fleksibel dan mengakui fakta bahwa kebutuhan organisasi dapat berubah. Jangka waktu yang panjang memungkinkan fleksibilitas dan kemampuan untuk beralih fokus sesuai kebutuhan.

Minggu Pertama dan Kedua

Sasaran:

• Siapkan perangkat pribadi dengan situs atau akun apa pun yang diperlukan untuk mengakses informasi.
• Mulailah mengembangkan struktur dan wireframe yang lebih mendetail untuk halaman landing.
• Diskusikan dengan mentor gaya untuk video, serta kembangkan template layar pembuka video, musik pengisi untuk layar judul dan akhir, serta informasi tambahan yang harus disertakan.
• Meninjau dokumentasi dan struktur dokumentasi saat ini untuk mengekstrak link yang akan digunakan dalam referensi tambahan dan referensi tutorial.

Minggu Ketiga hingga Keenam (Tutorial Pemula-Level 1)

Sasaran:

• Mengembangkan konten dan pelajaran awal untuk alur kerja INSTALL-IMPORT/Level 1. Buat video untuk proses download, penginstalan, konfigurasi, dan impor. Karena fungsi INSTALL-IMPORT adalah dasar untuk banyak alur kerja lainnya, dan paling sering digunakan, sebagian besar waktu akan dikhususkan untuk menyelesaikan tutorial dan pelajaran ini.
• Fokus pada jenis lokasi IMPORT dan kembangkan gambar yang menunjukkan kepada pengguna tempat mereka dapat memperoleh konten (saluran publik yang ada di Kolibri Studio) untuk halaman landing.
• Mengembangkan video dan konten tambahan untuk perluasan INSTALL-IMPORT (UPDATE channel). Perluasan ini juga dapat berupa referensi atau link tambahan ke dokumentasi yang ada.
• Menyiapkan subtitel untuk video apa pun.
• “Uji” video dan minta masukan dari sumber daya yang tersedia terkait kegunaan. Hal ini mencakup meninjau kembali template untuk video dan memperkuat template untuk video mendatang.

Minggu Ketujuh hingga Kesepuluh (Tingkat 2- Uploader Konten)

Sasaran:

• Fokus pada pelajaran dan video alur kerja untuk persona Uploader Studio.
• Selesaikan dokumentasi dan pelajaran untuk UPLOAD-PUBLISH-IMPORT.
• Mengembangkan subtitel untuk video apa pun.

Minggu Kesebelas hingga Keempatbelas (Level 3 - “Remixer” dan Editor Konten)

Sasaran:

• Fokus pada alur kerja berikut dan buat konten tutorial/pelajaran: UPLOAD-EDIT-PUBLISH-UPDATE dan EDIT-PUBLISH-UPDATE.
• Mengembangkan subtitel untuk video.

Minggu Kelima Belas hingga Kedelapan Belas

Sasaran:

• Seperti yang disampaikan selama riset saya untuk proposal ini, alur kerja yang melibatkan Ricecooker memiliki prioritas lebih rendah (jenis CHEFDEV). Tergantung pada waktu dan jadwal, saya dapat menggunakan waktu tersebut untuk membuat tutorial tingkat tinggi yang mengacu pada dokumentasi yang sudah ada untuk Ricecooker.

Minggu Sembilan Belas Hingga Dua Puluh Dua

Sasaran:

• Saat ini, pelajari kesenjangan yang ada, dan uji alur semua tutorial saat ini.
• Selesaikan halaman landing dan mulai tautkan video.
• Lakukan konversi draf halaman yang dibuat di Google Dokumen ke Markdown atau reStructuredText, seperti yang dibahas dengan mentor.

Minggu Dua Puluh Tiga Sampai Dua Puluh Lima

Sasaran:

• Bergantung pada waktu, selesaikan tugas akhir dengan tutorial lanjutan berprioritas rendah.
• Pengeditan halaman Read the Docs, pengujian file, pemeriksaan tata bahasa/ejaan di menit-menit terakhir.
• QA untuk setiap link di dalam video atau di halaman lain.

Minggu Ke-26

Minggu terakhir untuk project yang berjalan lama. Saya akan bekerja sama dengan mentor untuk menyelesaikan hasil project dan menyelesaikan dokumentasi Google akhir yang diperlukan.

Komponen Tutorial

Halaman Landing Tutorial

Pengguna akan mengakses halaman landing tutorial di situs Read the Docs dari Kolibri, yang akan memberikan gambaran singkat tentang berbagai tutorial yang ditawarkan untuk alur kerja konten. Tujuan halaman ini adalah untuk memberikan ringkasan singkat tentang ekosistem Kolibri serta memberikan tampilan grafis dari berbagai alur kerja. Hal ini memberi pengguna kemampuan untuk melihat jenis alur kerja yang sesuai dengan kebutuhan mereka, baik secara teknis maupun untuk kurikulum organisasi mereka. Pengguna akan lebih memahami opsi yang tersedia di Kolibri dan Kolibri Studio.

Halaman Tutorial dan Pelajaran

Setiap halaman beranda tutorial akan memberikan pengantar tutorial (terdiri dari beberapa pelajaran), diikuti dengan beberapa sasaran pengguna. Tutorial menggambarkan keseluruhan alur kerja dan terdiri dari setiap pelajaran. Setiap pelajaran akan memiliki video. Video akan membahas setiap bagian dari keseluruhan konsep. Setiap pelajaran akan disimpan di halaman terpisah dalam halaman induk alur kerja tutorial. Halaman pelajaran akan memiliki tombol yang memungkinkan pengguna membuka pelajaran sebelumnya atau berikutnya dalam tutorial. Konsep yang sangat kompleks dapat mencakup aktivitas latihan.

Video dan Struktur

Video akan menguraikan satu konsep. Video akan memberikan petunjuk saat melakukan tindakan tersebut di layar. Contoh video dapat ditemukan di sini: https://youtu.be/DkMP_VdGslU. Video contoh ini menampilkan cara menggunakan wizard Fasilitas Penyiapan.

Catatan: Meskipun video ini menunjukkan contoh konten yang ada, video ini dimaksudkan untuk menunjukkan gaya penggunaan info dan sorotan kursor untuk membuat gaya video yang konsisten.

Video ini menggunakan info dan kursor yang ditandai untuk membantu memandu pengguna melalui langkah-langkah konsep tunggal ini. Video akan dihosting di YouTube. Jika dihosting di YouTube, teks akan dibuat secara otomatis. Kemudian, saya akan mengedit teks untuk ejaan, tata bahasa, dan tanda baca. Teks tersebut kemudian dapat diekspor untuk diterjemahkan di Amara atau alat terjemahan lainnya.

Video akan memiliki layar judul yang konsisten, yang akan saya bahas dengan mentor dalam beberapa minggu pertama. Saya juga akan menggunakan gaya info yang konsisten (panah, sorotan kursor, kotak), yang akan diputuskan bersama dengan mentor dalam beberapa minggu pertama.

Contoh Struktur

Alur kerja yang paling sederhana, INSTALL-IMPORT, adalah seluruh tutorial. Dalam tutorial tersebut, ada dua kemungkinan pelajaran dengan video:

• Mendownload, Menginstal, dan Menyiapkan Fasilitas Kolibri Anda
• Mengimpor Konten di Kolibri Studio - Perhatikan bahwa video ini akan dirujuk oleh alur kerja lainnya

Tutorial yang lebih canggih memerlukan beberapa sub-pelajaran dengan beberapa video. Alur kerja UPLOAD-EDIT-PUBLISH-UPDATE mengikuti struktur di bawah ini.

Catatan: Jika alur kerja ini berada di luar halaman Kolibri Studio, dan ini adalah pertama kalinya Kolibri Studio diperkenalkan, halaman pengantar pelajaran untuk video ini akan memberikan link untuk login dan membuat akun Studio. Sub-pelajaran adalah halaman individual. Oleh karena itu, karena alur kerja ini lebih kompleks, setiap sub-pelajaran berisi beberapa video.

Pelajaran 1– Mengupload Konten dan Membuat Channel di Kolibri Studio

Sasaran Pengguna: Di akhir pelajaran ini, Anda akan mengetahui cara menyelesaikan tindakan berikut:

• Membuat channel di Kolibri Studio untuk digunakan di Kolibri. Anda akan mengetahui cara menggunakan token rahasia channel untuk mengimpor channel konten di Kolibri.
• Buat channel dengan mengimpor konten dari channel publik yang sudah ada di Koleksi Studio.
• Buat channel dengan mengupload konten dari komputer Anda.

Video Sub-Pelajaran:

• Sub-pelajaran 1 – Buat channel Anda sendiri di Kolibri Studio dan impor konten dari channel publik yang sudah ada (Khan Academy, PHET, dll.): Video 1 - Saluran konten publik (melihat saluran PUBLIK di Kolibri Studio) Video 2 – Membuat channel Video 3 – Mengimpor konten dari channel yang ada Video 4 – Memublikasikan channel dan mendapatkan token rahasia Video 5 – Mengimpor channel ke Kolibri menggunakan token rahasia
• Sub-pelajaran 2—Upload Channel Konten Dokumen Saya: Video 1 – Mengupload file dari Dokumen Saya Video 2—Membuat latihan Anda sendiri

Pelajaran 2 – Pengeditan Channel Lanjutan di Kolibri Studio

Sasaran Pengguna: Di akhir pelajaran ini, Anda akan mengetahui cara menyelesaikan tindakan berikut:

• Mengedit saluran konten di Kolibri Studio
• Mengelola saluran konten di Kolibri Studio

Video Sub-Pelajaran:

• Sub-pelajaran 1—Mengedit konten dengan menambahkan latihan, mengatur ulang struktur folder, dan opsi kolaborasi (1 video)
• Sub-pelajaran 2—Menggunakan fungsi lain seperti menghapus/memindahkan konten (1 video)

Pelajaran 3 – Memublikasikan Saluran Kolibri Studio untuk digunakan di Kolibri dan Memperbarui Saluran

Sasaran Pengguna: Di akhir pelajaran ini, Anda akan mengetahui cara menyelesaikan tindakan berikut:

• Publikasikan channel di Kolibri Studio dan publikasikan ulang setelah konten baru ditambahkan
• Mengupdate saluran
• Mendapatkan token channel untuk diimpor ke Kolibri (melalui link ke video sebelumnya di Pelajaran 1 yang membahas tindakan ini)

Video Sub-Pelajaran:

• Sub-pelajaran 1—Memublikasikan pembaruan ke channel

  Video 1: Memublikasikan ulang channel Video 2: Memperbarui channel di Kolibri setelah menambahkan konten tambahan