이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- INCF
- 테크니컬 라이터:
- hq
- 프로젝트 이름:
- 개방적이고 재현 가능한 신경과학을 위한 LORIS 교육 문서
- 프로젝트 기간:
- 장기 실행 (5개월)
Project description
I. 개요
LORIS (Longitmedual Online Research and Imaging System)는 신경영상 연구를 위한 웹용 프로젝트 관리 플랫폼으로서 여러 Open Science 이니셔티브를 지원합니다. 문서화는 LORIS에서 중요한 역할을 합니다. 특히 문서는 LORIS 사용자와 개발자가 소프트웨어 세부정보를 이해하여 플랫폼을 보다 효과적으로 사용하거나 소프트웨어 개발에 기여할 수 있도록 도와줍니다. 그동안 LORIS 문서도 업데이트해야 합니다. 이 프로젝트의 목표는 LORIS가 문서를 개선할 수 있도록 돕는 것입니다.
II. 현재 상태
LORIS는 현재 GitHub Wiki, Read the Docs 및 LORIS.ca 웹사이트를 사용하여 모든 문서를 호스팅하고 있습니다. 특히 LORIS GitHub Wiki는 가장 많은 양의 LORIS 문서를 호스팅하며 추가적인 LORIS 튜토리얼, 프레젠테이션, 사용자 가이드 및 둘러보기는 다양한 플랫폼에서 호스팅됩니다 . 현재 LORIS 문서는 LORIS 개발자와 사용자를 위한 가이드를 제공하지만 추가적인 개발 및 구성, 특히 문서 업데이트 및 기술 세부정보 개선 등의 이점을 누릴 수 있습니다.
III. 커뮤니티가 얻는 이점
개방적이고 재현 가능한 신경과학을 위한 LORIS 교육 문서를 개선함으로써 연구자와 개발자는 보다 사용자 친화적인 도구를 이용하여 연구의 데이터 수집을 개선할 수 있습니다. 특히 이 프로젝트는 LORIS 설치/설정 문서뿐 아니라 신규 사용자에게 교육을 제공하는 최종 사용자 자료를 업데이트하고 개선할 수 있습니다. 또한 프로젝트의 목표는 LORIS GitHub 위키의 문서를 이전하고 읽도록 하는 문서로 업데이트하는 것입니다. 한편 프로젝트에서는 데이터 관계를 전달하고 아키텍처 시각화를 개선하기 위한 데이터베이스 다이어그램을 제공할 수 있습니다. 마지막으로, 이 프로젝트는 사람들에게 LORIS, 오픈 과학 배경 정보, 사용 사례를 소개하는 콘텐츠를 업데이트하고 개선합니다.
IV. 프로젝트를 위한 개인적 강점
지난 몇 년 동안 저는 여러 기술 프로젝트에 참여하여 기술 글쓰기에 대한 탄탄한 배경지식을 쌓았습니다. 특히 예전에는 여러 팀 프로젝트에서 문서 작성을 담당했으며 Docs, Sphinx, Mkdocs, 마크다운, LaTeX 등의 기술 글쓰기 도구를 사용해 본 경험이 충분하다고 생각합니다. 또한 이전에 STEM 과정에서 교육한 경험을 통해 기술 커뮤니케이션 역량도 향상시켰습니다. IncF와 함께 재현 가능한 개방형 신경과학 프로젝트에 대한 LORIS 교육 문서는 제가 작성한 기술적 글쓰기 기법을 LORIS에 적용할 수 있는 좋은 기회가 될 것입니다. 게다가, 저는 신경영상 분야에 매우 관심이 있고 제 기술 지식을 이 분야에 적용할 기회를 찾기 위해 노력해 왔습니다. IncF와 함께 재현 가능한 개방형 신경과학 프로젝트에 대한 LORIS 교육 문서는 저에게 소중한 경험이 될 것입니다.
V. 결과물
- 기존 LORIS 문서 이전 및 업데이트
- LORIS 설치/설정 문서를 검토, 업데이트, 개선하고 신규 사용자에게 교육을 제공하는 최종 사용자 자료의 간극을 메웁니다.
- 데이터 관계 (예: 주제, 연구 방문)를 전달하고 아키텍처 시각화를 개선하기 위한 데이터베이스 다이어그램 생성 지원
- LORIS API 문서 업데이트 및 개선 참여
- 여러 미디어 형식과 관련된 LORIS, Open Science 컨텍스트, 사용 사례를 소개하는 콘텐츠를 업데이트하고 개선하는 데 도움을 줍니다.
VI. 타임라인
커뮤니티 유대감 (8월 17일~9월 13일) a) LORIS 소프트웨어 및 팀 워크플로를 완전히 숙지합니다. b) LORIS 설치/설정 문서를 검토, 업데이트, 개선합니다.
1주 차 (9월 14일~9월 20일) GitHub 위키에서 LORIS 문서를 업데이트하고 이전하여 문서를 읽습니다.
2주 차 (9월 21일~9월 27일) a) 현재 LORIS 최종 사용자 자료를 검토합니다. b) 최신 문서를 바탕으로 신규 사용자에게 교육을 제공하는 LORIS 최종 사용자 자료의 공백을 메우기 시작합니다.
3주 차 (9월 28일~10월 4일) 신규 사용자를 위한 교육을 제공하는 LORIS 최종 사용자 자료를 채워 격차를 마무리합니다.
4주 차 (10월 5일~10월 11일) a) 현재 LORIS 데이터베이스 아키텍처 이해하기 b) LORIS 플랫폼의 데이터베이스 다이어그램 구현을 시작합니다.
5주 차 (10월 12일~10월 18일) a) LORIS 데이터베이스 다이어그램 생성 작업을 완료합니다. b) 현재 LORIS API를 검토하고 API 문서 개선을 시작합니다.
6주 차 (10월 19일~10월 25일) LORIS API 문서 개선 작업을 계속합니다.
7주 차 (10월 26일~11월 1일) LORIS API 문서의 개선을 완료합니다.
8주 차 (11월 2일~11월 8일) 사람들을 LORIS에 대해 소개하는 현재 콘텐츠를 검토하고 업데이트를 시작하고 오픈 과학 관련 맥락을 개선합니다.
9주 차 (11월 9일~11월 15일) LORIS에 대해 소개하는 콘텐츠에서 오픈 과학 컨텍스트의 업데이트와 개선을 완료하세요.
10주 차 (11월 16일~11월 22일) 사용자에게 LORIS를 소개하는 콘텐츠의 일부 사용 사례를 업데이트하고 개선하도록 지원합니다.
11주 차 (11월 23일~11월 29일) 사용자에게 LORIS를 소개하는 콘텐츠에서 모든 사용 사례의 업데이트와 개선을 완료합니다.
프로젝트 완료 (11월 30일~12월 5일) a) 생성한 모든 문서 참여 내역을 정리합니다. b) GitHub에서 생성된 모든 pull 요청을 병합하고 생성한 모든 문제를 종료합니다. c) 최종 프로젝트 보고서를 완료하고 Google에 보고서를 제출합니다.
VII. 향후 결과물
Docs 2020 시즌이 끝난 후에도 계속해서 LORIS에 관한 문서에 기여하고 싶습니다. 특히 신규 출시를 위한 문서를 계속 업데이트하고 작성할 수 있는 가능성에 대해 LORIS 개발자와 논의해 보고자 합니다. 또한 Google 문서 시즌 프로젝트 중에 만든 문서를 검토하고 개선할 여지가 더 있는지 확인하고 싶습니다. 마지막으로 관련 엔지니어링 배경지식이 있으므로 향후 LORIS 소프트웨어의 다른 측면(예: 소프트웨어 개발)에 기여하고자 합니다.