이 페이지에는 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 Season of Docs에 참여하면서 오픈소스 세계에 발을 들였습니다. 올해에는 오픈소스 및 무료 소프트웨어의 다양성을 지원하는 공익사업 부문에 선정되기도 했습니다. 저는 Outreachy 프로젝트가 GitHub에서 호스팅되기 때문에 Git에 관심을 갖고 있으며 3월부터 Open Food Facts 및 Mozilla Fenix에 정기적으로 기고하고 있습니다. 저는 지난 3년 넘게 Linux 사용자였으며 그때부터 터미널 명령어를 사용해 왔습니다.
문서 도구와 언어는 Sphinx, 문서 읽기, 마크다운입니다. 이 아이디어가 마음에 들어 이 아이디어를 구현하고자 합니다. 관련 경험이 있으며 지식과 기술을 활용하여 DIPY에 기여하고 싶습니다. 디지털 이미지 처리, 컴퓨터 비전, 머신러닝 분야에서 경험이 있습니다. 신경영상을 더 잘 이해하고 문서를 작성하는 데 도움이 됩니다. 저는 의료 분야에서 풍부한 경험을 쌓았습니다. 의사, 환자, 실험실, 구급차 운전자를 위한 의료 웹사이트를 개발했습니다. 의사, 환자, 간호사, 실험실 조수, 연구원이 사용하는 다른 시스템을 개발했습니다. 이렇게 하면 사용자가 더 쉽게 이해할 수 있는 문서를 작성하는 데 도움이 됩니다.
DIPY 문서를 검토한 결과 문서에 몇 가지 결함이 있음을 확인했습니다. 문서에 개선해야 할 허점이 여러 개 있습니다. 문서의 현재 상태: 문서에 특정 구조와 디자인이 없습니다. 특히 초보자가 탐색하기에는 지루하고 시간이 많이 걸릴 수 있습니다. 사용자가 가이드에서 정보를 얻기 어려울 수 있습니다. 문서의 콘텐츠를 개선해야 합니다. 초보자로서 사용자 가이드와 개발자 가이드에 액세스하기가 어려웠습니다. 사용자에게 필요한 정보에 쉽게 액세스할 수 있도록 문서를 재구성해야 합니다. 문서에 일관성이 없습니다.
제가 계획한 작업은 다음과 같습니다.
문서의 특정 구조 및 템플릿 정의 사용자가 필요한 정보를 쉽게 탐색하고 찾을 수 있도록 문서 재구성 문서 작업에 커뮤니티를 참여시키기 위한 로드맵 또는 작업 항목 목록 작성 사용자 가이드 및 개발자 가이드의 템플릿 정의 참여 가이드의 템플릿 정의 사용자 가이드, 개발 가이드, 참여 가이드 (신규 사용자가 프로젝트에 참여하도록 유도하고 동기를 부여할 수 있음)를 수정, 재구성, 업데이트 텍스트가 아닌 이미지를 추가하여 텍스트 설명 개선 문서 전반의 일관성 개선 새로운 명령줄 인터페이스에 관한 문서 작성
사용자 가이드:
사용자 가이드의 경우 사용자가 가장 복잡한 시스템도 이해할 수 있도록 간단하고 명확한 언어를 사용하는 데 중점을 둘 것입니다. 신규 사용자가 모를 수 있는 전문 용어, 두문자어, 기타 내부자 정보는 사용자 환경을 개선하기 위해 피해야 합니다. 또한 사용자에게 시스템 작동 방식을 빠르게 보여주는 이미지, 주석이 달린 스크린샷, 그래픽, 동영상 등의 시각적 콘텐츠를 사용하는 데 중점을 둘 것입니다. 좋은 문서에는 사용자가 각 섹션에서 어떤 내용을 확인할 수 있는지 알 수 있는 제목 및 하위 제목의 계층 구조가 필요합니다. 그리고 이 계층 구조는 사용자가 가장 유용한 방식으로 시스템을 사용하는 방법을 배우는 데 도움이 되는 논리적인 흐름을 따라야 합니다. 이 프로젝트의 주요 목표 중 하나는 접근성 있는 콘텐츠를 만드는 것입니다. 모든 문서와 가이드가 일관된 스타일을 준수합니다. 여러 문서에서 일관된 글꼴과 보색을 사용하는 것이 필수입니다. 사용자가 시스템을 성공적으로 사용하는 방법에 관한 조직의 리소스에 더 많이 액세스할 수 있도록 하겠습니다.
개발자 가이드:
개발자 가이드에는 개발자가 DIPY의 소스 코드에 기여할 때 도움이 되는 광범위한 안내와 참조 자료가 포함되어 있습니다. 이 도구는 달성하려는 목표에 따라 적절한 접근 방식을 사용할 수 있도록 다양한 옵션을 제공합니다. 개발 가이드를 수정하고 재구성해야 합니다. 개발자 가이드의 콘텐츠를 다시 작성하겠습니다. 종속 항목 빌드, 기여 가이드, 스타일 가이드, 코딩 규칙, 문서 가이드, 개발 환경 설치, 디버깅, 테스트 가이드, 관련 항목이 포함되어 개발자가 쉽게 액세스할 수 있습니다. 열정적인 신규 참여자가 프로젝트로 달려와 첫 번째 오픈소스 참여를 할 때는 참여 가이드라인을 참고합니다. 따라서 가이드라인은 읽기 쉽고, 철저하며, 친근해야 합니다. 참여 가이드는 사용자가 오픈소스 프로젝트에 참여하는 방법을 알려주는 유용한 문서입니다. 프로젝트에 기여하는 것은 수정사항 제출, 버그 신고, 유지관리자 되기, 코드의 현재 상태 논의, 새 기능 제안 등 무엇이든 사용자에게 최대한 쉽고 투명하게 제공되어야 합니다.
TEMPLATE
참여 가이드에 사용할 수 있는 템플릿 중 하나입니다. 문서의 요구사항에 따라 수정할 수 있으며 섹션을 추가하거나 삭제할 수 있습니다.
DIPY에 참여
- 환영 인사
TOC
윤리 강령
- Google의 표준
- 긍정적인 환경을 조성하는 데 도움이 되는 행동의 예
- 참여자의 허용되지 않는 행동의 예
- Google의 책임
- 프로젝트 유지관리자의 책임
- 범위
윤리 강령의 범위
지원하기 위해 알아야 할 사항이 있나요?
코드 제공에 도움을 주고 싶으시다면 Google 프로젝트에서 [프로젝트에서 사용하는 프로그래밍 언어, 프레임워크 또는 도구 목록 삽입]을(를) 사용합니다. 아직 코드를 기여할 준비가 되지 않았더라도 괜찮습니다. 문서 문제[Issue Tracker의 문서 라벨 또는 태그 링크] 또는 디자인 문제[프로젝트에서 디자인 문제를 추적하는 경우 Issue Tracker의 디자인 라벨 또는 태그 링크]를 확인할 수도 있습니다. 코드 기여에 관심이 있고 Google에서 사용하는 기술에 대해 자세히 알아보려면 아래 목록을 확인하세요. 신규 참여자가 프로젝트에 참여하기 위해 알아야 하는 사항을 알아볼 수 있는 리소스 (튜토리얼, 동영상, 책)의 글머리기호 목록을 포함합니다.
개발 환경 설정
이 섹션에서는 설치해야 하는 설치 절차와 종속 항목을 추가합니다. install project를 실행하여 $project를 설치합니다.
- 소스 코드: github.com/$project/$project
- Issue Tracker: github.com/$project/$project/issues
기여 방법
버그 신고 방법
- 버그 신고 제출 전
- (좋은) 버그 신고를 제출하려면 어떻게 해야 하나요?
변경사항 제출 방법
- 풀 요청 프로토콜
- 팀의 응답
- 응답 속도
개선사항 요청 방법
- 개선사항 제안을 제출하기 전에
- 개선 제안을 제출하려면 어떻게 해야 하나요?
첫 번째 코드 참여
- 초보자 문제
- 도움이 필요한 문제 #### pull 요청
- pull 요청 생성 절차
- 모든 상태 검사를 통과하는지 확인합니다.
상태 확인에 실패하면 어떻게 되나요?
- 작성 테스트
- 테스트 범위
스타일 가이드
- Git 커밋 메시지
- 표준 스타일
지원
문제가 있는 경우 알려주세요. 도움이 필요하면 project@google-groups.com의 메일링 리스트, IRC 채팅 또는 [프로젝트에서 사용하는 기타 커뮤니케이션 플랫폼 나열]에서 질문할 수 있습니다.
라이선스
이 섹션에서는 프로젝트의 라이선스에 대해 설명합니다.
시간 약정 및 커뮤니케이션:
일주일에 45시간 이상을 지급할 예정이지만 사고가 발생할 경우 주말에 해당 시간에 대한 보상을 제공합니다. 커뮤니티 결속 기간 동안 커뮤니케이션 수단을 논의하고 멘토와 함께 주간 회의, 수단, 회의 시간을 최종 결정할 예정입니다. 멘토에게 작업에 관한 최신 정보를 제공하고 이메일을 통해 작업 세부정보를 공유합니다. 화면 공유 등의 다양한 기능을 쉽게 사용할 수 있으므로 TeamViewer와 소통하는 것이 좋습니다.