DIPY 프로젝트

이 페이지에는 Google Season of Docs에서 수락된 기술 작문 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:
DIPY
테크니컬 라이터:
아레샤 타리크
프로젝트 이름:
대략적인 구조 조정 및 최종 사용자에 집중
프로젝트 기간:
표준 기간 (3개월)

Project description

소프트웨어 엔지니어이며 기술 문서 작성에 대한 전문 지식을 갖추고 있습니다. 고품질 소프트웨어 문서, 사용자 가이드, 매뉴얼, 프로젝트 설명 작성 분야에서 4년 이상의 경험을 쌓았습니다. 저는 파키스탄 이슬라마바드에 거주합니다 (시간대: UTC + 5). 현재 저는 Outreachy의 인턴으로 일하고 있으며 8월 18일까지 업무를 계속할 예정입니다. OpenELIS Global 조직에서 테크니컬 라이터로 Google Season of Docs에 참여했습니다. 원본 문서는 프랑스어로 되어 있고 제한적이며 오래되었으므로 영어로 광범위하고 업데이트된 최종 사용자 문서를 작성했습니다. 저는 2020년 5월부터 8월까지 진행된 Perl & Raku 조직의 Outreachy에서 Open Food Facts 서버의 백엔드 개발자로 선정되었습니다. 백엔드 개발 외에도 이 인턴십의 주요 과제 중 하나는 모듈 및 함수에 대한 문서를 POD 형식으로 작성하는 것입니다. 작년에 오픈소스 프로젝트에 참여했고 이후 Google Docs의 Season of Docs에 참여하면서 오픈소스에 입문했습니다. 올해는 오픈소스 및 무료 소프트웨어의 다양성을 지원하는 공익사업 부문에 선정되었습니다. Outreachy 프로젝트가 GitHub에 호스팅되므로 Git에 대한 이해도가 높으며 3월부터 Open Food Facts 및 Mozilla Fenix에 정기적으로 기여하고 있습니다. Linux 사용자로서 지난 3년 이상 사용되었으며 그때부터 터미널 명령어를 사용해 왔습니다.

제가 사용한 문서 도구와 언어는 Sphinx, 문서 읽기, Markdown입니다. 관련 경험이 있고 저의 지식과 기술을 활용해 DIPY에 기여하고 싶기 때문에 이 아이디어가 마음에 들어 이를 실현하고 싶습니다. 디지털 이미지 처리, 컴퓨터 비전, 머신러닝 분야에서 경험이 있습니다. 신경 이미징을 더 잘 이해하고 문서를 작성하는 데 도움이 될 것입니다. 저는 의료 분야에서 방대한 경험을 쌓았습니다. 의사, 환자, 연구소, 구급차 운전사를 위한 의료 웹사이트를 개발했습니다. 의사, 환자, 간호사, 연구 보조원, 연구원이 사용하는 또 다른 시스템을 작업했습니다. 이렇게 하면 교육 대상이 더 쉽게 이해할 수 있는 문서를 작성하는 데 도움이 됩니다.

DIPY의 문서를 검토했으며 문서의 몇 가지 결함을 확인했습니다. 문서에 개선하고자 하는 여러 허점이 있습니다. 문서의 현재 상태: 문서에 구체적인 구조와 설계가 없습니다. 특히 신규 사용자가 탐색하는 데 지루하고 시간이 오래 걸릴 수 있습니다. 사용자는 가이드에서 정보를 얻기 어려울 수 있습니다. 문서 내용을 개선해야 합니다. 신규 사용자로서 사용자 가이드와 개발자 가이드에 액세스하기가 어려웠습니다. 사용자가 필요로 하는 정보에 쉽게 액세스할 수 있도록 문서의 모양을 변경해야 합니다. 문서의 일관성이 부족함

다음을 할 계획입니다.

문서의 특정 구조와 템플릿을 정의합니다. 사용자가 쉽게 탐색하고 필요한 정보를 찾을 수 있도록 문서의 모양을 변경합니다. 추가 문서 작업에 커뮤니티에 참여하기 위한 로드맵이나 작업 항목 목록을 생성합니다. 사용자 가이드 및 개발자 가이드를 위한 템플릿을 정의합니다. 사용자 가이드, 개발 가이드, 기여 가이드를 다시 작성, 재구성, 업데이트합니다. 새 사용자가 프로젝트에 기여하도록 돕고 새 사용자가 프로젝트에 기여하도록 유도할 수 있습니다. 명령어 인터페이스가 아닌 텍스트 인터페이스를 개선합니다.

사용자 가이드:

사용자 가이드에서는 사용자가 가장 복잡한 시스템도 이해할 수 있도록 간단하고 평이한 언어를 사용하는 데 초점을 맞추겠습니다. 사용자 경험을 개선하기 위해 신규 사용자가 모를 수 있는 전문 용어, 두문자어, 기타 내부자 정보를 피합니다. 또한 사용자에게 시스템 작동 방식을 신속하게 보여주는 이미지, 주석이 달린 스크린샷, 그래픽, 동영상 등의 시각적 콘텐츠를 사용하는 데 집중할 것입니다. 좋은 문서에는 사용자가 각 섹션에서 표시할 내용을 알 수 있도록 제목 및 부제목의 계층 구조가 필요합니다. 그리고 이 계층 구조는 사용자가 가장 유용한 방식으로 시스템을 사용하는 방법을 배우는 데 도움이 되는 논리적인 흐름을 따라야 합니다. 이 프로젝트의 주요 목표 중 하나는 접근성이 뛰어난 콘텐츠를 제작하는 것입니다. 모든 문서와 가이드는 일관된 스타일을 따릅니다. 여러 문서에 걸쳐 일관적인 글꼴과 상호 보완적인 색상을 사용해야 합니다. 사용자가 시스템을 성공적으로 활용하는 방법에 관한 조직의 리소스에 더 많이 액세스할 수 있도록 할 것입니다.

개발자 가이드:

개발자 가이드에는 개발자가 DIPY의 소스 코드에 기여하는 데 도움이 되는 광범위한 안내와 참조 자료가 포함되어 있습니다. 사용 가능한 다양한 옵션을 배치하려고 시도하므로, 달성하려는 목표에 따라 올바른 접근 방식을 사용할 수 있습니다. 개발 가이드의 형태를 바꾸고 재구성해야 합니다. 개발자 가이드의 내용을 다시 작성하겠습니다. 종속 항목 빌드, 참여 가이드, 스타일 가이드, 코딩 규칙, 문서 가이드, 개발 환경 설치, 디버깅, 테스트 가이드 및 관련 내용이 포함되어 개발자가 쉽게 액세스할 수 있습니다. 신규 기여자가 처음으로 오픈소스 기여를 하기 위해 프로젝트로 몰려올 때는 기여 가이드라인을 지도하는 역할을 합니다. 따라서 가이드라인이 읽기 쉽고 꼼꼼하며 친근해야 합니다. 참여 가이드는 오픈소스 프로젝트에 참여하는 방법을 알려주는 유용한 문서입니다. 다음과 같은 상황에서 사용자가 가능한 한 쉽고 투명하게 프로젝트에 기여할 수 있어야 합니다. 수정사항 제출 버그 신고 유지관리 담당자 되기 코드의 현재 상태 논의 새로운 기능 제안

TEMPLATE

후원 가이드에 사용할 수 있는 템플릿 중 하나입니다. 이 섹션은 수정할 수 있으며 문서의 요구사항에 따라 섹션을 추가하거나 삭제할 수 있습니다.

DIPY에 참여

  • 환영 인사

TOC

윤리 강령

  • Google의 기준
  • 긍정적인 환경을 조성하는 데 기여하는 행동의 예
  • 참가자가 허용하지 않는 행동의 예
  • YouTube의 책임
  • 프로젝트 유지관리자의 책임
  • 범위

윤리 강령의 범위

도움을 받으려면 알아야 할 사항은 무엇인가요?

코드 기여와 관련해 도움을 받고자 하는 경우 [프로젝트에서 사용하는 프로그래밍 언어, 프레임워크 또는 도구 목록 삽입]을(를) 사용하세요. 아직 코드를 기부할 준비가 되지 않았더라도 걱정하지 마세요. 또한 문서 문제[Issue Tracker의 문서 라벨 또는 태그 링크] 를 확인하거나 [프로젝트에서 디자인 문제를 추적하는 경우 Issue Tracker의 디자인 라벨 또는 태그 링크]에서 발생한 디자인 문제를 확인할 수도 있습니다. 코드를 기여하는 데 관심이 있고 Google에서 사용하는 기술에 대해 자세히 알아보려면 아래 목록을 확인하세요. 새 기여자가 프로젝트에 참여하기 위해 알아야 할 사항을 알아보는 데 사용할 수 있는 리소스 (튜토리얼, 동영상, 도서)의 글머리 기호 목록을 포함합니다.

개발 환경 설정

이 섹션에서는 설치 절차와 설치해야 하는 종속 항목을 추가합니다. install project를 실행하여 $project를 설치합니다.

  • 소스 코드: github.com/$project/$project
  • Issue Tracker: github.com/$project/$project/issues

기여 방법

버그 신고 방법

  • 버그 신고를 제출하기 전에
  • 좋은 버그 신고를 제출하려면 어떻게 해야 하나요?

변경사항 제출 방법

  • pull 요청 프로토콜
  • 팀의 답변
  • 응답 속도

개선사항 요청 방법

  • 개선사항 추천을 제출하기 전에
  • (좋은) 개선 제안은 어떻게 제출하나요?

첫 번째 코드 기여

  • 초보자 문제
  • 지원 요청 문제 #### pull 요청
  • pull 요청 생성 프로세스
  • 모든 상태 확인을 통과하는지 확인합니다.

상태 확인에 실패하면 어떻게 되나요?

  • 테스트 작성
  • 테스트 범위

스타일 가이드

  • Git 커밋 메시지
  • 표준 스타일

지원

문제가 있는 경우 알려 주시기 바랍니다. 도움이 필요한 경우 Google의 메일링 리스트(project@google-groups.com), IRC 채팅 또는 [프로젝트에서 사용하는 기타 커뮤니케이션 플랫폼 나열]에 문의하시기 바랍니다.

라이선스

이 섹션에서는 프로젝트 라이선스에 대해 설명합니다.

시간 투자 및 커뮤니케이션:

일주일에 45시간 이상 근무할 예정이지만, 문제가 발생할 경우 주말에 보충하겠습니다. 커뮤니티 유대감 기간에는 멘토와의 커뮤니케이션 수단에 대해 논의하고 주간 회의, 수단, 시간을 마무리합니다. 멘토에게 제 업무에 대한 최신 정보를 제공할 것이며 멘토에게 이메일로 작업 세부정보를 공유할 것입니다. TeamViewer는 화면 공유 등의 다양한 기능을 통해 사용하기 쉽기 때문에 커뮤니케이션할 때 더 선호합니다.