Projekt Kolibri

Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.

Podsumowanie projektu

Organizacja open source:

Kolibri

Pisarz techniczny:

Danielle V

Nazwa projektu:

Procesy związane z treściami w Kolibri

Długość projektu:

Długookresowa (5 miesięcy)

Opis projektu

Poniższa propozycja została opracowana na podstawie badań i rozmów z mentorami Kolibri. Rozmowa z mentorami pomogła mi w opracowaniu profili użytkowników, które omówię poniżej. Dzięki tym rozmowom wpadł mi do głowy pomysł na repozytorium samouczników lub stronę docelową, aby użytkownicy mogli wybrać samouczek odpowiedni dla swoich potrzeb.

Omówienie

Ta propozycja przedstawia rozwiązanie do kierowania różnych ścieżek użytkownika, które mogą importować z komputera do Kolibri Studio, a następnie z Kolibri Studio do Kolibri. Proponuję utworzenie centralnego repozytorium samouczków. Użytkownik będzie miał dostęp do tych samouczków ze strony docelowej. Strona docelowa zawiera tabelę z linkami do poszczególnych samouczników dotyczących przepływu pracy oraz wskazuje typ użytkownika, któremu mogą one pomóc. Dzięki temu samouczki będą lepiej dopasowane do potrzeb i umiejętności użytkownika. W wielu lekcjach omawiany jest przepływ pracy (np. INSTALACJA-IMPORT). Każda lekcja zawiera film. Filmy pokazują niewielką część procesu i demonstrują poszczególne koncepcje łączenia aplikacji Kolibri.

Główne cele

1. Utwórz stronę docelową z samouczkiem, która pomoże użytkownikom zdecydować, który przepływ pracy najlepiej odpowiada ich potrzebom. Ta strona docelowa będzie hostowana na platformie Read the Docs.

2. Utwórz osobne lekcje dla poszczególnych elementów każdego procesu i uzupełnij trudne lekcje ćwiczeniami.

3. Utwórz interaktywne filmy dla każdego procesu.

Narzędzia projektu

Praca będzie wykonywana przy użyciu oprogramowania do nagrywania ekranu. Mam doświadczenie z Camtasia, ale pracowałem też z oprogramowaniem o niższych kosztach i bezpłatnym. Przykładowy film, do którego link znajduje się tutaj (https://youtu.be/DkMP_VdGslU), powstał przy użyciu technologii Flashback firmy Blueberry Software, na którą mam obecnie licencję. Napiszę napisy w YouTube. Strony samouczników będą hostowane na stronie Read the Docs firmy Kolibri. Wersja robocza zostanie ukończona w Dokumentach Google. Mogę pomóc w konwersji plików tekstowych na format Markdown lub reStructuredText na potrzeby wersji końcowej.

Oś czasu

Ten projekt będzie zgodny z długoterminowymi wytycznymi dotyczącymi projektu (łącznie 26 tygodni, od 2 września 2019 r. do 28 lutego 2020 r.). Będę poświęcać około 10 godzin tygodniowo na realizację celów opisanych poniżej. Oprócz realizacji tych celów będę w razie potrzeby brać udział w spotkaniach z mentorami i komunikacji. Wspólnie z mentorami ustalimy najlepszy termin. Ogólnie harmonogram jest podzielony na 4-tygodniowe odcinki, w ramach których będę tworzyć wiele filmów, stron z samouczkami i ćwiczeń.

Uwaga: ten harmonogram jest elastyczny i uwzględnia fakt, że potrzeby organizacji mogą się zmieniać. Długie ramy czasowe zapewniają elastyczność i możliwość zmiany priorytetów w razie potrzeby.

Tydzień 1 i 2

Cele:

• Skonfiguruj urządzenie osobiste z dowolnymi stronami lub kontami potrzebnymi do uzyskania dostępu do informacji.
• Zacznij opracowywać strukturę i bardziej szczegółowy schemat strony docelowej.
• Porozmawiaj z mentorami o stylu filmów, a także przygotuj szablon otwierającego ekranu filmu, muzykę wypełniającą na potrzeby ekranu tytułowego i końcowego oraz dodatkowe informacje, które powinny się w nich znaleźć.
• Przejrzyj aktualną dokumentację i jej strukturę, aby wyodrębnić linki do dodatkowych zasobów i samouczków.

Tygodnie od 3 do 6 (poziom 1 – samouczki dla początkujących)

Cele:

• opracować początkowe treści i lekcje dla procesu INSTALL-IMPORT/Level 1. Utwórz film przedstawiający procesy pobierania, instalowania, konfigurowania i importowania. Ponieważ funkcje INSTALL-IMPORT są podstawą wielu innych przepływów pracy i są najczęściej używane, poświęcimy dużo czasu na dopracowanie tych samouczków i lekcji.
• Skoncentruj się na typach lokalizacji, które służą do importowania, i opracuj grafikę pokazującą użytkownikowi, gdzie może pozyskać treści na stronie docelowej (kanały publiczne dostępne w Kolibri Studio).
• Utwórz dodatkowe filmy i inne treści, które rozszerzą kampanię INSTALL-IMPORT (UPDATE). Mogą one mieć postać dodatkowych zasobów lub linków do istniejącej dokumentacji.
• Pracować nad napisami do dowolnych filmów.
• „Przetestuj” filmy i poproś o opinię na temat ich przydatności z dostępnych źródeł. Obejmuje to ponowne sprawdzenie szablonu filmów i ustabilizowanie go na potrzeby kolejnych filmów.

Tygodnie 7–10 (poziom 2 – osoba przesyłająca treści)

Cele:

• Skup się na wykładach i filmach z przepływu pracy w celu stworzenia profilu osoby przesyłającej w Studio.
• Wypełnij dokumentację i lekcje dotyczące funkcji UPLOAD-PUBLISH-IMPORT.
• Tworzenie napisów do dowolnych filmów.

Tygodnie od 11. do 14. (poziom 3. – „remixer” treści i edytor)

Cele:

• Skoncentruj się na następujących przepływach pracy i utwórz treść samouczka/lekcji: UPLOAD-EDIT-PUBLISH-UPDATE i EDIT-PUBLISH-UPDATE.
• tworzyć napisy do filmów.

Tydzień 15–18

Cele:

• Jak wynika z moich badań nad tą propozycją, przepływy pracy wykorzystujące Ricecooker mają niższą priorytet (typ CHEFDEV). W zależności od czasu i harmonogramu mogę wykorzystać ten czas na stworzenie ogólnego samouczka, który odwołuje się do istniejącej dokumentacji dotyczącej Ricecooker.

Tygodnie 19–22

Cele:

• Sprawdź, czy nie ma żadnych luk, i przetestuj obecny przebieg wszystkich samouczków.
• Dokończ tworzenie strony docelowej i zacznij łączyć filmy.
• Przekonwertuj wersje robocze stron utworzone w Dokumentach Google na format Markdown lub reStructuredText zgodnie z rozmowami z mentorami.

Tygodnie 23–25

Cele:

• W zależności od czasu, dokończ pracę nad zaawansowanymi samouczkami o niskim priorytecie.
• Ostatnia minuta: zapoznaj się z informacjami o edytowaniu strony Dokumentów, testowaniu plików oraz sprawdzaniu gramatyki i pisowni.
• Kontrola jakości linków w filmach i na innych stronach.

Tydzień 26

Ostatni tydzień dla długotrwałych projektów. Wspólnie z mentorami zajmę się przygotowaniem dokumentów projektowych i wymaganej dokumentacji Google.

Komponenty samouczka

Strona docelowa samouczka

Użytkownicy mają dostęp do strony docelowej samouczka w witrynie Czytaj dokumenty Kolibri, która zawiera krótki zarys różnych samouczków oferowanych w ramach przepływów pracy związanych z treścią. Celem tej strony jest przedstawienie ogólnego obrazu ekosystemu Kolibri oraz graficzne przedstawienie różnych procesów roboczych. Dzięki temu użytkownik może wyświetlić typ przepływu pracy, który odpowiada jego potrzebom, zarówno pod względem technicznym, jak i w zakresie programu nauczania organizacji. Użytkownicy będą lepiej rozumieć opcje dostępne w Kolibri i Kolibri Studio.

Strony samouczków i lekcji

Na stronie głównej każdego samouczka znajduje się wprowadzenie do samouczka (składa się on z kilku lekcji), a potem cele użytkownika. Samouczki ilustrują cały proces i składają się z indywidualnych lekcji. Każda lekcja będzie zawierać film. Filmy będą dotyczyć poszczególnych części ogólnego zagadnienia. Każda lekcja będzie przechowywana na osobnej stronie w ramach strony głównej przepływu pracy w ramach samouczka. Strony lekcji będą zawierać przyciski umożliwiające użytkownikowi przejście do poprzedniej lub następnej lekcji w samouczku. Bardzo skomplikowane zagadnienia mogą obejmować ćwiczenia praktyczne.

Filmy i struktura

Filmy będą przedstawiać pojedynczą koncepcję. Filmy będą zawierać instrukcje dotyczące wykonywania danej czynności na ekranie. Przykładowy film znajdziesz tutaj: https://youtu.be/DkMP_VdGslU. Ten przykładowy film pokazuje, jak korzystać z kreatora konfiguracji obiektu.

Uwaga: ten film jest przykładem istniejących treści, ale ma pokazać, jak można używać objaśnień i wyróżnień kursora, aby nadać filmowi spójny styl.

Film zawiera objaśnienia i wyróżniony kursor, które pomagają poprowadzić użytkownika przez poszczególne etapy tego pojedynczej koncepcji. Filmy będą hostowane w YouTube. Jeśli są hostowane w YouTube, napisy będą generowane automatycznie. Następnie poprawię pisownię, gramatykę i interpunkcję. Te napisy można następnie wyeksportować do tłumaczenia w Amara lub innym narzędziu do tłumaczenia.

Filmy mają spójny ekran tytułowy, o którym chcę porozmawiać z mentorami w ciągu pierwszych kilku tygodni. Będę też używać spójnego stylu objaśnień (strzałki, podświetlenie kursora, pola), który zostanie ustalony wspólnie z mentorami w ciągu kilku pierwszych tygodni.

Przykładowe struktury

Najprostszy proces, INSTALL-IMPORT, to cały samouczek. W tym samouczku są 2 możliwe lekcje z filmem:

• Pobieranie, instalowanie i konfigurowanie Kolibri Facility
• Importowanie treści w Kolibri Studio – pamiętaj, że do tego filmu odwołują się inne procesy

Bardziej zaawansowany samouczek wymaga wielu lekcji z większą liczbą filmów. Procedura PRZEŚLIJ-EDYTUJ-PUBLIKUJ-AKTUALIZUJ jest zgodna z podaną niżej strukturą.

Uwaga: jeśli ten przepływ pracy znajduje się poza stronami Kolibri Studio i po raz pierwszy wprowadzasz Kolibri Studio, na stronie z wprowadzeniem do tych filmów znajdziesz linki do logowania się i tworzenia konta w Studio. Podlekcje to pojedyncze strony. Ze względu na większą złożoność tego procesu każda podlekcja zawiera kilka filmów.

Lekcja 1. Przesyłanie treści i tworzenie kanałów w Kolibri Studio

Cele użytkownika: po zakończeniu tej lekcji będziesz wiedzieć, jak wykonać te czynności:

• Możesz utworzyć kanały do wykorzystania w Kolibri w Kolibri Studio. Dowiesz się, jak korzystać z tajnych tokenów kanału, aby zaimportować kanał treści w Kolibri.
• Utwórz kanał, importując treści z istniejących publicznych kanałów w Bibliotece Studio.
• Utwórz kanał, przesyłając treści z komputera.

Filmy z podlekcjami:

• Sub-lesson 1 – Create your own channels on Kolibri Studio and import content from existing public channels (Khan Academy, PHET, etc.): Film 1 – Publiczne kanały z treściami (wyświetlanie PUBLICZNYCH kanałów w Kolibri Studio) Film 2 – Tworzenie kanału Film 3 – Importowanie treści z istniejących kanałów Film 4 – Publikowanie kanału i uzyskiwanie tajnego tokena Film 5 – Importowanie kanału do Kolibri za pomocą tajnego tokena
• Podlekcji 2 – Przesyłanie treści z kanału Moje dokumenty: Film 1 – Przesyłanie plików z Moje dokumenty Film 2 – Tworzenie własnych ćwiczeń

Lekcja 2. Zaawansowane edytowanie kanałów w Kolibri Studio

Cele użytkownika: po zakończeniu tej lekcji powiemy Ci, jak:

• Edytowanie kanałów treści w Kolibri Studio
• Zarządzanie kanałami treści w Kolibri Studio

Filmy z podlekcjami:

• Podlekcji 1 – edytowanie treści przez dodawanie ćwiczeń, zmianę struktury folderów i opcje współpracy (1 film)
• Sub-lesson 2—Using other functions such as deleting/moving content (1 video)

Lekcja 3. Publikowanie kanałów Kolibri Studio do wykorzystania w Kolibri i aktualizowanie kanałów

Cele użytkownika: po zakończeniu tej lekcji będziesz wiedzieć, jak wykonać te czynności:

• Publikowanie kanału w Kolibri Studio i ponowne publikowanie po dodaniu nowych treści
• Aktualizowanie kanału
• Uzyskaj token kanału, aby zaimportować go do Kolibri (za pomocą linku do poprzedniego filmu w Lekcji 1, który zawiera informacje na temat tego działania)

Filmy z podlekcji:

• Sub-lesson 1—Publishing updates to a channel

  Film 1. Ponownie publikowanie kanału Film 2. Aktualizowanie kanału w Kolibri po dodaniu dodatkowych treści