Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- kolibri
- Pisarz techniczny:
- Danielle V
- Nazwa projektu:
- Przepływy pracy w treściach Kolibri
- Długość projektu:
- Długotrwałe (5 miesięcy)
Opis projektu
Opracowana niżej propozycja powstała na podstawie badań i rozmów z mentorami projektu Kolibri. Rozmowa z mentorami pomogła mi opracować profile użytkowników, które omówię poniżej. Podczas dzisiejszej rozmowy udało mi się też uzyskać pomysł dotyczący repozytorium samouczka lub strony docelowej, aby użytkownicy mogli wybrać, który z samouczków chcą przeglądać.
Omówienie
Propozycja ta stanowi rozwiązanie ułatwiające kierowanie użytkowników przez różne ścieżki użytkownika, które można zaimportować podczas importowania treści z komputera do Kolibri Studio, a następnie z Kolibri Studio do Kolibri. Proponuję utworzenie centralnego repozytorium samouczków. Użytkownik może uzyskać dostęp do samouczków przez stronę docelową. Na stronie docelowej znajdziesz tabelę z linkami do każdego samouczka przepływu pracy, wskazując typ użytkownika, który może być przydatny w przypadku samouczka. Dzięki temu samouczki będą lepiej dopasowane do potrzeb i umiejętności użytkowników. Przepływ pracy (np. INSTALL- IMPORT) jest prezentowany w kilku lekcjach. Każda lekcja zawiera film. Filmy pokazują mały fragment przepływu pracy i poszczególne koncepcje na temat tego, jak te przepływy pracy łączą aplikacje Kolibri.
Główne cele
Utwórz stronę docelową samouczka, która pomoże użytkownikom zdecydować, który przepływ pracy najlepiej odpowiada ich potrzebom. Ta strona docelowa będzie hostowana na platformie Czytaj dokumenty.
Twórz indywidualne lekcje na temat poszczególnych etapów pracy i uzupełniaj trudne lekcje ćwiczeniami.
Stwórz interaktywne filmy na potrzeby każdego przepływu pracy.
Narzędzia projektu
Prace będą wykonywane za pomocą oprogramowania do prezentowania ekranu. Mam doświadczenie z firmą Camtasia, ale współpracowałam z tańszym oprogramowaniem i oprogramowaniem freeware. Przykładowy film, do którego link znajdziesz tutaj (https://youtu.be/DkMP_VdGslU), został stworzony przy pomocy Flashback firmy Blueberry Software, na którą mam obecnie licencję. Utworzę napisy w YouTube. Strony z samouczkami będą hostowane w witrynie Read the Docs firmy Kolibri. Wersje robocze zostaną ukończone w Dokumentach Google. Mogę pomóc w konwersji plików tekstowych na format Markdown lub reStructuredText w ostatecznej wersji produktu.
Oś czasu
Ten projekt będzie zgodny z długoterminowymi wytycznymi 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 wymienionych poniżej. Oprócz tego będę w tym czasie brać udział w spotkaniach z mentorami i w razie potrzeby brać udział w komunikacji. Wspólnie z mentorami określimy, kiedy najlepiej się to odbywa. Oś czasu jest zasadniczo podzielona na 4-tygodniowe fragmenty, gdzie będę tworzyć wiele filmów, stron z samouczkami i ćwiczeń.
Tydzień 1 i 2
Cele:
- Skonfiguruj na swoim urządzeniu strony internetowe i konta, które będą potrzebne do uzyskania dostępu do informacji.
- Zacznij opracowywać strukturę i bardziej szczegółowy schemat strony docelowej.
- Omów z mentorami styl tworzenia filmów, opracuj szablon ekranu początkowego, dodaj muzykę do tytułu i ekranu końcowego oraz opracuj dodatkowe informacje, które należy uwzględnić.
- Zapoznaj się z bieżącą dokumentacją i strukturą dokumentacji, aby wyodrębnić linki do wykorzystania w dodatkowych zasobach i odwołaniach do samouczka.
Tygodnie 3–6 (poziom 1 – samouczki dla początkujących)
Cele:
- Opracuj wstępne treści i lekcje dotyczące procesu INSTALL-IMPORT/Poziom 1. Nagraj film na temat procesów pobierania, instalacji, konfiguracji i importowania. Ponieważ funkcje INSTALL-IMPORT są podstawą wielu innych przepływów pracy, a jest to najczęściej używane, poświęcona będzie duża część czasu na przygotowanie samouczków i lekcji.
- Skup się na typach lokalizacji służących do importowania danych i opracuj grafikę, która będzie przykładem dla użytkownika, w którym może pozyskiwać treści na stronę docelową (kanały publiczne dostępne w Kolibri Studio).
- Przygotuj dodatkowe filmy i treści, które będą stanowić rozwinięcie kanału INSTALL-IMPORT (AKTUALIZACJI). Rozszerzenia mogą też mieć formę dodatkowych zasobów lub linków do istniejącej dokumentacji.
- Przygotuj napisy do filmów.
- „Przetestuj” filmy i poproś o opinię na temat wszelkich dostępnych zasobów związanych z łatwością obsługi. Wiąże się to z ponownym przejściem do szablonu filmów i udoskonaleniem go na potrzeby przyszłych filmów.
Tygodnie od 7 do 10 (poziom 2 – przesyłający treści)
Cele:
- Skup się na lekcjach i filmach dotyczących procesu pracy, aby lepiej poznać osoby przesyłające dane w Studio.
- Wypełnij dokumentację i lekcje na temat UPLOAD-OPUBLIKUJ-IMPORTUJ.
- Twórz napisy do dowolnych filmów.
Tydzień 11 do 14 (poziom 3 – remikser i edytujący treści)
Cele:
- Skup się na tych przepływach pracy i utwórz samouczek lub treść lekcji: UPLOAD-EDIT-publish-UPDATE i EDIT-OPUBLIKUJ.
- Twórz napisy do filmów.
Od 15 do 18 tygodni
Cele:
- Przepływy pracy dotyczące systemu Ricecooker mają niższy priorytet (typ CHEFDEV). W zależności od terminu i harmonogramu mogę wykorzystać ten czas do stworzenia ogólnego samouczka na podstawie istniejącej dokumentacji aplikacji Ricecooker.
Od 19 do 22 tygodni
Cele:
- W tym momencie oceń ewentualne luki i przetestuj bieżący przepływ wszystkich samouczków.
- Dokończ konfigurację strony docelowej i zacznij łączyć ze sobą filmy.
- Przekonwertuj wersje robocze stron utworzone w Dokumentach Google na format Markdown lub reStructuredText w sposób uzgodniony z mentorami.
Tygodnie 23–25
Cele:
- W zależności od czasu dokończ pracę nad zaawansowanymi samouczkami o niskim priorytecie.
- Ostatnia minuta Przeczytaj: edytowanie strony Dokumentów, testowanie plików oraz sprawdzanie gramatyki i pisowni.
- Kontrola jakości wszystkich linków w filmach lub na innych stronach.
Tydzień 26.
Ostatni tydzień dla długotrwałych projektów. Będę współpracować z mentorami, aby podsumowywać zadania do wykonania w ramach projektu i uzupełniać wszelkie wymagane dokumenty Google.
Komponenty samouczka
Strona docelowa samouczka
Użytkownicy mają dostęp do strony docelowej samouczka w serwisie Read the Docs firmy Kolibri, gdzie znajduje się krótki opis różnych samouczków dotyczących przepływu pracy treści. Na tej stronie przedstawiamy krótki opis ekosystemu Kolibri oraz graficzny obraz różnych przepływów pracy. Dzięki temu użytkownicy mogą wyświetlić przepływ pracy, który odpowiada jego potrzebom zarówno pod względem technicznym, jak i związanym z programem nauczania organizacji. Użytkownicy będą mogli lepiej poznać opcje dostępne w Kolibri i Kolibri Studio.
Samouczek i strony lekcji
Każda strona główna samouczka zawiera wprowadzenie do samouczka (składa się z kilku lekcji) oraz informacje o celach użytkownika. Samouczki ilustrują cały proces i składają się z pojedynczych lekcji. Każda lekcja zawiera film. Filmy będą dotyczyć określonej części ogólnej koncepcji. Każda lekcja będzie umieszczona na osobnej stronie na stronie nadrzędnej przepływu pracy samouczka. Na stronach lekcji znajdują się przyciski umożliwiające użytkownikom przejście do poprzedniej lub następnej lekcji w samouczku. Bardzo złożone koncepcje mogą obejmować ćwiczenia.
Filmy i struktura
Filmy będą zawierać 1 koncepcję. Podczas wykonywania tej czynności na ekranie filmy będą podpowiadać kierunki działania. Przykładowy film znajdziesz tutaj: https://youtu.be/DkMP_VdGslU. Ten przykładowy film pokazuje, jak korzystać z kreatora konfiguracji infrastruktury.
Objaśnienia i wyróżniony kursor w filmie pomagają użytkownikowi w utworzeniu wskazówek dotyczących omawianej kwestii. Filmy będą hostowane w YouTube. Jeśli film jest hostowany w YouTube, napisy zostaną wygenerowane automatycznie. Następnie edytuję napisy pod kątem pisowni, gramatyki i interpunkcji. Napisy można wyeksportować do tłumaczenia w Amarze lub innym narzędziu do tłumaczenia.
Filmy będą miały spójny ekran tytułowy, który w ciągu pierwszych kilku tygodni chcę omówić z mentorami. Będę też stosować spójny styl objaśnienia (strzałki, wyróżnienie kursora, pola), który zostanie ustalony z mentorami w ciągu pierwszych kilku tygodni.
Przykładowe struktury
Najprostszy przepływ pracy, INSTALL-IMPORT, to cały samouczek. Ten samouczek zawiera dwie potencjalne lekcje razem z filmem:
- Pobieranie, instalowanie i konfigurowanie urządzenia Kolibri
- Importowanie treści w Kolibri Studio – pamiętaj, że do tego filmu będą odnosiły się inne przepływy pracy
Bardziej zaawansowany samouczek składa się z kilku lekcji podrzędnych z kilkoma filmami. Przepływ pracy UPLOAD-EDIT-publish-UPDATE ma poniższą strukturę.
Lekcja 1. Przesyłanie treści i tworzenie kanałów w Kolibri Studio
Cele użytkowników: po zakończeniu tej lekcji dowiesz się, jak:
- Twórz kanały w Kolibri Studio, aby ich używać w Kolibri. Będziesz wiedzieć, jak użyć tajnych tokenów kanału, aby zaimportować kanał z treściami w Kolibri.
- Utwórz kanał, importując treści z istniejących kanałów publicznych z biblioteki Studio.
- Utwórz kanał, przesyłając treści z komputera.
Filmy z podlekcji:
- Lekcja podrzędna 1 – Tworzenie własnych kanałów w Kolibri Studio i importowanie treści z istniejących kanałów publicznych (Khan Academy, PHET itp.): Film 1 – kanały z treściami publicznymi (oglądanie kanałów publicznych 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
- Lekcja 2 – Przesyłanie treści z kanału Moje dokumenty: Film 1 – Przesyłanie plików z Moich dokumentów Film 2 – Tworzenie własnych ćwiczeń
Lekcja 2. Zaawansowana edycja kanałów w Kolibri Studio
Cele użytkowników: po zakończeniu tej lekcji dowiesz się, jak:
- Edytowanie kanałów z treścią w Kolibri Studio
- Zarządzanie kanałami treści w Kolibri Studio
Filmy z podlekcji:
- Lekcja 1 – Edycja treści przez dodawanie ćwiczeń, reorganizowanie struktury folderów i opcji współpracy (1 film)
- Lekcja podrzędna 2 – Używanie innych funkcji, takich jak usuwanie lub przenoszenie treści (1 film)
Lekcja 3. Publikowanie kanałów Kolibri Studio do użytku w Kolibri i ich aktualizowanie
Cele użytkowników: po zakończeniu tej lekcji dowiesz się, jak:
- Opublikuj kanał w Kolibri Studio i opublikuj go ponownie po dodaniu nowych treści.
- Aktualizowanie kanału
- Uzyskaj token kanału, który chcesz zaimportować do Kolibri (poprzez link do poprzedniego filmu z lekcji 1, który dotyczy tego działania)
Filmy z podlekcji:
Lekcja 1 – Publikowanie aktualizacji na kanale
Film 1: Ponowna publikacja kanału Film 2: Aktualizacja kanału w Kolibri po dodaniu dodatkowych treści