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