Project Kolibri

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

Ringkasan proyek

Organisasi open source:

Kolibri

Penulis teknis:

Danielle V

Nama proyek:

Alur Kerja Konten Kolibri

Durasi proyek:

Jangka panjang (5 bulan)

Project description

Proposal di bawah dibuat dengan melakukan riset dan berbicara dengan mentor Kolibri. Percakapan saya dengan para mentor membantu saya mengembangkan persona pengguna yang saya bahas di bawah ini. Selain itu, diskusi saya membantu saya menghasilkan ide terkait repositori/halaman landing tutorial sehingga pengguna dapat memilih tutorial yang sesuai dengan kebutuhan mereka.

Ringkasan

Proposal ini menyajikan solusi untuk memandu berbagai perjalanan pengguna yang dapat dilakukan oleh individu untuk mengimpor konten dari komputernya ke Kolibri Studio, lalu dari Kolibri Studio ke Kolibri. Saya mengusulkan untuk membuat repositori pusat untuk tutorial. 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 dimanfaatkan oleh tutorial tersebut. Dengan cara ini, tutorial akan lebih dipersonalisasikan dengan kebutuhan dan kemampuan pengguna. Alur kerja (misalnya, INSTAL-IMPOR) ditunjukkan oleh beberapa pelajaran. Setiap pelajaran berisi satu video. Video menunjukkan sebagian kecil alur kerja dan mendemonstrasikan konsep individual tentang bagaimana alur kerja ini menghubungkan aplikasi Kolibri.

Sasaran Utama

1. Buat halaman landing tutorial yang membantu pengguna menentukan alur kerja yang paling sesuai dengan kebutuhan mereka. Halaman landing ini akan dihosting di platform Baca Dokumen.

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

3. Buat video interaktif untuk setiap alur kerja.

Alat Project

Pekerjaan akan dilakukan menggunakan software screencasting. Saya memiliki pengalaman dengan Camtasia, tetapi saya juga bekerja dengan perangkat lunak dan perangkat gratis yang berbiaya lebih rendah. Contoh video yang ditautkan di sini (https://youtu.be/DkMP_VdGslU) dibuat dengan Flashback oleh Blueberry Software, yang saat ini saya miliki lisensinya. Saya akan membuat subtitel menggunakan YouTube. Halaman tutorial akan dihosting di situs Bacakan Dokumen Kolibri. Pekerjaan draf akan diselesaikan di Google Docs dan saya dapat membantu mengonversi {i>file<i} teks menjadi 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 tujuan yang diuraikan di bawah ini. Selain tujuan tersebut, saya akan mengambil bagian dalam pertemuan mentor dan komunikasi selama waktu ini, jika diperlukan. Saya akan bekerja sama dengan para mentor untuk menentukan waktu terbaik. Garis waktu biasanya dibagi menjadi empat minggu, di mana saya akan membuat sejumlah video, halaman tutorial, dan latihan.

Catatan: Linimasa ini fleksibel dan menyadari fakta bahwa kebutuhan organisasi dapat berubah. Jangka waktu yang besar memungkinkan fleksibilitas dan kemampuan untuk mengalihkan fokus sesuai kebutuhan.

Minggu Ke-1 dan Kedua

Sasaran:

• Siapkan perangkat pribadi dengan situs atau akun apa pun yang diperlukan untuk mengakses informasi.
• Mulailah mengembangkan struktur dan {i>wireframe<i} yang lebih rinci untuk halaman muka.
• Berdiskusilah dengan mentor tentang gaya pembuatan video, dan kembangkan {i>template<i} layar pembuka video, musik pengisi apa pun untuk judul dan layar akhir, serta informasi tambahan yang harus disertakan.
• Tinjau dokumentasi dan struktur dokumentasi saat ini untuk mengekstrak link guna digunakan dalam referensi tambahan dan referensi tutorial.

Minggu Tiga Sampai Enam (Level 1- Tutorial Pemula)

Sasaran:

• Kembangkan konten dan pelajaran awal untuk alur kerja INSTALL-IMPORT/Level 1. Buat video untuk proses download, penginstalan, konfigurasi, dan impor. Karena fungsi INSTAL-IMPORT adalah dasar bagi banyak alur kerja lainnya, dan yang paling umum digunakan, sebagian besar waktu akan dicurahkan untuk menyelesaikan tutorial dan pelajaran ini.
• Fokus pada jenis lokasi IMPORT dan kembangkan grafik yang menunjukkan kepada pengguna tempat mereka dapat memperoleh konten (saluran publik yang ada di Kolibri Studio) untuk halaman landing.
• Kembangkan video dan konten tambahan untuk perluasan INSTALL-IMPORT (channel UPDATE). Perluasan ini juga dapat berupa referensi atau tautan tambahan ke dokumentasi yang ada.
• Buat subtitel untuk video apa pun.
• “Uji” video dan minta masukan dari referensi yang tersedia terkait kegunaan. Hal ini termasuk meninjau kembali {i>template<i} untuk video dan memperkuat {i>template<i} untuk video di masa mendatang.

Minggu Ketujuh Sampai Sepuluh (Level 2- Uploader Konten)

Sasaran:

• Fokus pada video pelajaran dan alur kerja untuk persona Uploader Studio.
• Lengkapi dokumentasi dan pelajaran untuk UPLOAD-PUBLIK-IMPOR.
• Kembangkan subtitel untuk video apa pun.

Eleven Sampai Empat Belas Minggu (Level 3 - Konten “Remixer” dan Editor)

Sasaran:

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

Minggu Kelima Belas Sampai Delapan Belas

Sasaran:

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

Minggu Sembilan Belas Sampai Dua Puluh Dua

Sasaran:

• Menilai celah yang ada saat ini, dan menguji alur dari semua tutorial saat ini.
• Menyelesaikan pembuatan halaman landing dan mulai menautkan video.
• Lakukan konversi draf halaman yang dilakukan di Google Dokumen ke Markdown atau reStructuredText, seperti yang telah dibahas dengan mentor.

Minggu Kedua Puluh Tiga Sampai Dua Puluh Lima

Sasaran:

• Bergantung pada waktu, selesaikan setiap pekerjaan akhir pada tutorial lanjutan berprioritas rendah.
• Menit terakhir Baca pengeditan halaman Dokumen, pengujian file, pemeriksaan tata bahasa/ejaan.
• UM (Uji Mutu) untuk semua link dalam video atau halaman lain.

Minggu Kedua Puluh Enam

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

Komponen Tutorial

Halaman Landing Tutorial

Pengguna akan mengakses halaman landing tutorial di situs Read the Docs milik Kolibri, yang akan memberikan garis besar singkat tentang berbagai tutorial yang ditawarkan untuk alur kerja konten. Tujuan halaman ini adalah memberikan ringkasan singkat tentang ekosistem Kolibri serta memberikan tampilan grafis 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. Pengguna akan lebih memahami opsi yang tersedia bagi mereka di Kolibri dan Kolibri Studio.

Halaman Tutorial dan Pelajaran

Setiap halaman beranda tutorial akan menampilkan pengantar tutorial (terdiri dari beberapa pelajaran), diikuti dengan beberapa tujuan pengguna. Tutorial menggambarkan seluruh alur kerja dan terdiri dari pelajaran individual. Setiap pelajaran akan memiliki video. Video akan membahas bagian individu dari keseluruhan konsep. Setiap pelajaran akan disimpan di halaman individual dalam halaman induk alur kerja tutorial. Halaman pelajaran akan memiliki tombol yang memungkinkan pengguna untuk 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 arahan saat melakukan tindakan tersebut di layar. Contoh video dapat ditemukan di sini: https://youtu.be/DkMP_VdGslU. Video contoh ini menunjukkan cara menggunakan wizard Fasilitas Penyiapan.

Catatan: Meskipun video ini adalah contoh konten yang sudah 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 disorot untuk membantu memandu pengguna melalui langkah-langkah dari 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 terjemahan di Amara atau alat terjemahan lainnya.

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

Contoh Struktur

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

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

Tutorial lanjutan lainnya memerlukan beberapa subpelajaran 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 merupakan kali pertama 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 banyak video.

Pelajaran 1– Mengupload Konten dan Membuat Channel di Kolibri Studio

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

• Buat 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 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 ada (Khan Academy, PHET, dll.): Video 1 - Saluran konten publik (melihat channel PUBLIK di Kolibri Studio) Video 2 – Membuat channel Video 3 – Mengimpor konten dari channel yang ada Video 4 – Memublikasikan channel dan memperoleh token rahasia Video 5 – Mengimpor channel Anda ke Kolibri menggunakan token rahasia
• Sub-pelajaran 2—Upload Saluran Konten Dokumen Saya: Video 1 – Mengupload file dari Dokumen Saya Video 2—Membuat latihan Anda sendiri

Pelajaran 2 – Pengeditan Lanjutan Channel di Kolibri Studio

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

• Mengedit channel konten di Kolibri Studio
• Mengelola channel 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

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

• Memublikasikan channel di Kolibri Studio dan memublikasikan 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 update ke channel

  Video 1: Memublikasikan ulang saluran Video 2: Memperbarui saluran di Kolibri setelah menambahkan konten lain