이 페이지에는 Google 시즌의 Docs에 승인된 기술 글쓰기 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- INCF
- 테크니컬 라이터:
- hq
- 프로젝트 이름:
- 개방형 재현 가능한 신경과학에 관한 LORIS 교육 문서
- 프로젝트 길이:
- 장기 실행 (5개월)
Project description
I. 개요
LORIS (Longitudinal Online Research and Imaging System)는 여러 오픈 사이언스 이니셔티브를 지원하는 뇌영상 연구를 위한 웹 기반 프로젝트 관리 플랫폼입니다. 문서는 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 위키의 문서를 이전하고 문서를 Read the Docs로 업데이트하는 것을 목표로 할 것입니다. 한편 프로젝트는 데이터 관계를 전달하고 아키텍처 시각화를 개선하기 위해 데이터베이스 다이어그램을 제공할 수 있습니다. 마지막으로 이 프로젝트에서는 LORIS, 개방형 과학 맥락, 사용 사례를 소개하는 콘텐츠를 업데이트하고 개선할 예정입니다.
IV. 프로젝트에 대한 개인적인 강점
지난 몇 년간 여러 기술 프로젝트에 참여하여 기술 문서 작성에 대한 탄탄한 배경을 쌓았습니다. 특히 과거의 여러 팀 프로젝트에서 문서 작성을 담당했으며 Read the Docs, Sphinx, Mkdocs, 마크다운, LaTeX 등과 같은 기술적 글쓰기 도구를 사용한 경험이 충분하다고 생각합니다. 한편, 이전의 STEM 수업을 들은 경험으로 기술 커뮤니케이션 역량도 향상되었습니다. INCF와 함께 재현 가능한 오픈 뇌과학 프로젝트를 위한 LORIS 교육 문서는 제 기술 문서 작성 기법을 LORIS에 적용할 수 있는 좋은 기회가 될 것입니다. 또한 저는 신경 이미지 분야에 관심이 많으며, 이 분야에 제 기술적 지식을 적용할 기회를 찾고 있습니다. INCF와 함께 재현 가능한 오픈 뇌과학 프로젝트를 위한 LORIS 교육 문서는 저에게 매우 유용한 경험이 될 것입니다.
V. 결과물
- 현재 LORIS 문서 이전 및 업데이트
- LORIS 설치/설정 문서를 검토, 업데이트, 개선하고 신규 사용자 교육을 제공하는 최종 사용자 자료의 공백을 메웁니다.
- 데이터 관계 (예: 피험자, 연구 방문)를 전달하고 아키텍처 시각화를 개선하기 위한 데이터베이스 다이어그램을 생성하는 데 도움
- LORIS API 문서 업데이트 및 개선 지원
- LORIS, 개방형 과학 맥락, 사용 사례를 소개하는 콘텐츠를 업데이트하고 개선하는 데 도움을 줍니다(다양한 미디어 형식 포함).
VI. 타임라인
커뮤니티 결속 (8월 17일~9월 13일) a) LORIS 소프트웨어 및 팀 워크플로에 대한 완전한 숙지. b) LORIS 설치/구성 문서 검토, 업데이트, 개선
1주차 (9월 14일~9월 20일) LORIS 문서를 업데이트하고 GitHub 위키에서 Read the Docs로 이전합니다.
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에서 생성된 모든 풀 리퀘스트를 병합하고 내가 만든 모든 문제를 종료합니다. c) 최종 프로젝트 보고서를 작성하고 Google에 제출합니다.
VII. 향후 결과물
Google Docs 2020 시즌 이후에도 LORIS 문서에 계속 기여하고 싶습니다. 구체적으로 LORIS 개발자와 새 버전의 문서를 계속 업데이트하고 작성할 가능성에 대해 논의하고자 합니다. 또한 Google Season of Docs 프로젝트에서 작성한 문서를 검토하고 개선의 여지가 있는지 확인하는 데 시간을 더 할애하고자 합니다. 마지막으로 관련 엔지니어링 배경이 있으므로 향후 LORIS 소프트웨어의 다른 측면(예: 소프트웨어 개발)에 기여할 수 있습니다.