이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- 콜리브리
- 테크니컬 라이터:
- 대니엘 V
- 프로젝트 이름:
- Kolibri 콘텐츠 워크플로
- 프로젝트 기간:
- 장기 실행 (5개월)
Project description
아래의 제안은 연구를 수행하고 Kolibri 멘토와 대화하면서 작성되었습니다. 멘토와의 대화는 아래에서 논의한 사용자 캐릭터를 개발하는 데 도움이 되었습니다. 또한 토론을 통해 사용자가 필요에 따라 어떤 튜토리얼을 볼지 선택할 수 있도록 튜토리얼 저장소/방문 페이지에 관한 아이디어를 구상할 수 있었습니다.
개요
이 제안은 개인이 컴퓨터에서 Kolibri Studio로, 그리고 Kolibri Studio에서 Kolibri로 콘텐츠를 가져올 수 있는 다양한 사용자 경험을 안내하는 솔루션을 제시합니다. 튜토리얼의 중앙 저장소를 만드는 것이 좋습니다. 사용자는 방문 페이지를 통해 이러한 튜토리얼에 액세스할 수 있습니다. 방문 페이지에는 각 워크플로 튜토리얼의 링크가 포함된 표가 있으며 이 튜토리얼을 통해 도움이 될 사용자 유형을 표시합니다. 이렇게 하면 사용자의 필요와 능력에 더 잘 맞는 튜토리얼이 제공됩니다. 워크플로 (예: 설치, 가져오기)는 여러 강의를 통해 시연됩니다. 각 강의에는 동영상이 포함됩니다. 동영상 워크플로의 일부를 보여주며 이러한 워크플로가 Kolibri 애플리케이션을 연결하는 방식에 대한 개별 개념을 보여줍니다.
주요 목표
사용자가 자신의 필요에 가장 적합한 워크플로를 결정하는 데 도움이 되는 튜토리얼 방문 페이지를 만듭니다. 이 방문 페이지는 Docs 읽기 플랫폼에서 호스팅됩니다.
각 워크플로의 구성요소에 대한 개별 강의를 만들고 연습을 통해 어려운 수업을 보충할 수 있습니다.
워크플로마다 대화형 동영상을 만드세요.
프로젝트 도구
작업은 스크린캐스팅 소프트웨어를 사용하여 이뤄집니다. 저는 Camtasia를 사용한 경험이 있지만, 비용이 덜 드는 소프트웨어와 프리웨어로도 작업한 경험이 있습니다. 여기 (https://youtu.be/DkMP_VdGslU)에 링크된 샘플 동영상은 현재 라이선스를 보유한 Blueberry Software의 Flashback으로 제작되었습니다. YouTube를 사용해 자막을 만들겠습니다. 튜토리얼 페이지는 Kolibri의 Read the Docs 사이트에 호스팅됩니다. 초안 작업은 Google Docs에서 완료되며 최종 제품에 대해 텍스트 파일을 Markdown 또는 reStructuredText로 변환하도록 도와드리겠습니다.
일정
이 프로젝트는 장기 프로젝트 가이드라인 (2019년 9월 2일~2020년 2월 28일, 총 26주)을 따릅니다. 일주일에 10시간 정도를 아래에 설명된 목표를 완료하는 데 할애할 것입니다. 이러한 목표 외에도 이 기간 동안 필요에 따라 멘토 미팅과 커뮤니케이션에 참여할 계획입니다. 멘토와 함께 이 활동에 가장 적합한 시간을 결정하겠습니다. 타임라인은 일반적으로 4주 단위로 나뉘며 여러 개의 동영상, 튜토리얼 페이지, 연습 자료를 만들게 됩니다.
1주 및 2주
목표:
- 개인 기기에 정보에 액세스하는 데 필요한 웹사이트나 계정을 설정합니다.
- 방문 페이지의 구조와 보다 자세한 와이어프레임을 개발하기 시작합니다.
- 멘토와 동영상 스타일에 대해 논의하고 동영상 시작 화면 템플릿, 제목 및 종료 화면에 사용할 음악, 포함해야 할 추가 정보를 개발합니다.
- 최신 문서 및 문서 구조를 검토하여 추가 리소스 및 튜토리얼 참조에 사용할 수 있는 링크를 추출합니다.
3주~6주 (레벨 1 - 초보자 튜토리얼)
목표:
- INSTALL-IMPORT/Level 1 워크플로에 대한 초기 콘텐츠와 강의를 개발합니다. 다운로드, 설치, 구성, 가져오기 프로세스에 대한 동영상을 만듭니다. INSTALL-IMPORT 함수는 다른 많은 워크플로의 기반이며 가장 일반적으로 사용되므로 이러한 튜토리얼과 과정을 완료하는 데 많은 시간이 소요됩니다.
- IMPORT 위치 유형에 중점을 두고 사용자가 방문 페이지의 콘텐츠 (Kolibri Studio에 있는 공개 채널)를 얻을 수 있는 위치를 보여주는 그래픽을 개발합니다.
- INSTALL-IMPORT (UPDATE 채널) 확장을 위한 추가 동영상과 콘텐츠를 개발합니다. 이러한 확장은 추가 리소스 또는 기존 문서 링크의 형태로 제공될 수도 있습니다.
- 동영상의 자막을 만듭니다.
- 동영상을 '테스트'하고 사용 가능한 리소스 사용성과 관련해 의견을 구합니다. 여기에는 동영상의 템플릿을 다시 정하고 향후 동영상을 위한 템플릿을 확고히 하는 것이 포함됩니다.
7~10주 (레벨 2 - 콘텐츠 업로더)
목표:
- 스튜디오 업로더에 해당하는 강의와 워크플로 동영상에 중점을 둡니다.
- UPLOAD-PUBLISH-IMPORT에 대한 문서와 강의를 완료하세요.
- 모든 동영상의 자막을 개발합니다.
Weeks Eleven~14 (레벨 3 - 콘텐츠 '리믹서' 및 편집자)
목표:
- 업로드-수정-게시-업데이트 및 수정-게시-업데이트 워크플로에 중점을 두고 튜토리얼/강의 콘텐츠를 만듭니다.
- 동영상의 자막을 개발합니다.
15주~18주
목표:
- 이 제안서를 조사하는 동안 알 수 있듯이 Ricecooker와 관련된 워크플로는 우선순위가 더 낮습니다 (CHEFDEV 유형). 시기와 일정에 따라 이 시간에 Ricecooker의 기존 문서를 참조하는 개략적인 튜토리얼을 만들 수 있습니다.
19주~22주
목표:
- 이 시점에서 부족한 부분을 평가하고 모든 튜토리얼의 현재 흐름을 테스트합니다.
- 방문 페이지를 마무리하고 함께 동영상을 연결합니다.
- 멘토와 논의한 대로 Google Docs에서 작성된 페이지 초안을 Markdown 또는 reStructuredText로 변환하는 작업을 진행해 보세요.
23주~25주
목표:
- 시간에 따라 우선순위가 낮은 고급 튜토리얼에서 최종 작업을 완료합니다.
- 마지막 시간 문서 페이지 수정, 파일 테스트, 문법/맞춤법 검사를 읽어보세요.
- 동영상 내 또는 다른 페이지의 링크에 대해 품질보증을 수행합니다.
26주 차
장기 실행 프로젝트의 마지막 주입니다. 멘토와 함께 프로젝트 결과물을 마무리하고 필요한 최종 Google 문서를 작성하겠습니다.
튜토리얼 구성요소
튜토리얼 방문 페이지
사용자는 Kolibri의 Docs 읽기 사이트에 있는 튜토리얼 방문 페이지에 액세스할 수 있습니다. 여기에서 콘텐츠 워크플로에 제공되는 다양한 튜토리얼에 대한 간략한 개요를 확인할 수 있습니다. 이 페이지의 목적은 Kolibri 생태계에 대한 간략한 개요를 제공하고 다양한 워크플로의 그래픽 뷰를 제공하는 것입니다. 이를 통해 사용자는 기술 및 조직의 교육과정 둘 다에 맞는 워크플로 유형을 확인할 수 있습니다. 사용자는 Kolibri 및 Kolibri 스튜디오에서 사용할 수 있는 옵션을 더 잘 이해할 수 있습니다.
튜토리얼 및 강의 페이지
각 튜토리얼 홈페이지에서는 튜토리얼을 소개하는 튜토리얼 (여러 강의로 구성)과 몇 가지 사용자 목표를 제공합니다. 튜토리얼은 전체 워크플로를 보여주며 개별 강의로 구성됩니다. 강의마다 동영상이 있습니다. 동영상에서는 전체 콘셉트의 개별 부분을 다룹니다. 각 강의는 튜토리얼 워크플로 상위 페이지 내 개별 페이지에 보관됩니다. 강의 페이지에는 사용자가 가이드 내의 이전 또는 다음 과정으로 이동할 수 있는 버튼이 있습니다. 매우 복잡한 개념에는 연습 활동이 포함될 수 있습니다.
동영상 및 구조
동영상에서는 한 가지 컨셉을 소개합니다. 화면에서 해당 동작을 수행하는 동안 동영상이 방향을 알려줍니다. 예시 동영상은 https://youtu.be/DkMP_VdGslU에서 확인할 수 있습니다. 이 예제 동영상은 설정 시설 마법사를 사용하는 방법을 보여줍니다.
동영상에서는 콜아웃과 강조 표시된 커서를 사용하여 이 컨셉의 단계를 사용자에게 안내합니다. 동영상은 YouTube에서 호스팅됩니다. YouTube에서 호스팅되는 경우 자막이 자동으로 생성됩니다. 그런 다음 맞춤법, 문법, 구두점을 수정하여 자막을 수정합니다. 자막은 Amara 또는 다른 번역 도구로 번역할 수 있습니다.
동영상의 제목 화면이 일관되게 표시되며 처음 몇 주 동안 멘토와 이 화면을 논의할 예정입니다. 또한 일관된 콜아웃 스타일 (화살표, 커서 강조표시, 상자)을 사용할 예정이며, 이는 처음 몇 주 내에 멘토와 함께 결정합니다.
구조 예
가장 간단한 워크플로인 INSTALL-IMPORT는 전체 튜토리얼입니다. 이 튜토리얼에는 동영상이 포함된 2개의 강의가 있습니다.
- Kolibri 시설 다운로드, 설치, 설정
- Kolibri 스튜디오에서 콘텐츠 가져오기 - 이 동영상은 다른 워크플로에서 참조됨
고급 튜토리얼의 경우 동영상이 여러 개인 하위 강의가 여러 개 필요합니다. 업로드-수정-게시-업데이트 워크플로는 아래 구조를 따릅니다.
강의 1 – Kolibri 스튜디오에서 콘텐츠 업로드 및 채널 만들기
사용자 목표: 이 강의가 끝나면 다음 액션을 완료하는 방법을 알 수 있습니다.
- Kolibri에서 사용할 채널을 Kolibri 스튜디오에서 만듭니다. 채널의 보안 토큰을 사용하여 Kolibri로 콘텐츠 채널을 가져오는 방법을 알 수 있습니다.
- 스튜디오 라이브러리의 기존 공개 채널에서 콘텐츠를 가져와 채널을 만듭니다.
- 컴퓨터에 있는 콘텐츠를 업로드하여 채널을 만드세요.
하위 강의 동영상:
- 하위 강의 1 – Kolibri 스튜디오에서 나만의 채널을 만들고 기존 공개 채널 (Khan Academy, PHET 등)에서 콘텐츠를 가져옵니다. 동영상 1 - 공개 콘텐츠 채널 (Kolibri 스튜디오에서 공개 채널 보기) 동영상 2 – 채널 만들기 동영상 3 – 기존 채널에서 콘텐츠 가져오기 동영상 4 – 채널 게시 및 보안 비밀 토큰 가져오기 동영상 5 – 비밀번호 토큰을 사용하여 Kolibri로 채널 가져오기
- 하위 강의 2—내 문서 콘텐츠 채널 업로드: 동영상 1 – 내 문서에서 파일 업로드 동영상 2—나만의 연습 만들기
강의 2 – Kolibri 스튜디오에서 채널 고급 편집
사용자 목표: 이 강의가 끝나면 다음 액션을 완료하는 방법을 알 수 있습니다.
- Kolibri 스튜디오에서 콘텐츠 채널 편집
- Kolibri 스튜디오에서 콘텐츠 채널 관리
하위 강의 동영상:
- 하위 강의 1—운동 추가, 폴더 구조 재구성, 공동작업 옵션을 통한 콘텐츠 편집 (동영상 1개)
- 하위 강의 2—콘텐츠 삭제/이동과 같은 기타 기능 사용하기 (동영상 1개)
강의 3 – Kolibri에서 사용할 Kolibri Studio 채널 게시 및 채널 업데이트
사용자 목표: 이 강의가 끝나면 다음 액션을 완료하는 방법을 알 수 있습니다.
- Kolibri 스튜디오에서 채널을 게시하고 새 콘텐츠가 추가된 후 다시 게시
- 채널 업데이트
- Kolibri로 가져올 채널 토큰 획득 (이 작업을 다룬 강의 1의 이전 동영상 링크를 통해)
하위 강의 동영상:
하위 강의 1—채널 업데이트 게시하기
동영상 1: 채널 재게시 동영상 2: 추가 콘텐츠를 추가한 후 Kolibri의 채널 업데이트하기