이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- 장고
- 테크니컬 라이터:
- 개비프레시스
- 프로젝트 이름:
- 사용자 친화적이고 쉽게 탐색할 수 있도록 참여 가이드 재작성
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
추상
다른 모든 문서와 마찬가지로 Django 참여 가이드의 목표는 이 사례에서 사용자와 오픈소스 기여자가 Django를 더 우수하고 지속 가능하게 만드는 방법과 위치에 기여할 수 있는 방법을 안내하는 것입니다.
항상 커뮤니티와 Django 자체에 큰 영향을 미치는 문서를 만들어야 합니다.
올해의 Google Summer of Docs에서 Django의 목표는 덜 부담스럽고, 접근성이 높으며, 다른 참여자를 환영하는 참여 가이드를 만드는 것입니다. 이는 기여자를 장려하는 데 있어 필수적인 목표이며, 저 역시 이 훌륭한 프레임워크에 기여하기 위해 제가 속해 있는 일입니다.
현재 상태
여기에서 확인할 수 있는 이 문서의 현재 단계는 가이드가 아니라
프로젝트 목표
저는 포럼에서 멘토인 칼튼 깁슨과 문서에 대한 제안 사항을 논의했고, 멘토는 현재 문서의 가장 큰 문제를 해결하는 데 도움이 될 것이라는 데 동의합니다. 문서 재구성을 달성하고자 하는 목표는 다음과 같습니다. 문서 재구성 섹션 권장사항 및 주의사항 기능 요청 및 만들기와 같은 사소한 섹션의 단일 페이지 만들기 기능 요청 및 만들기와 같은 간단한 섹션용 문서 축약된 도움말 문서 새로운 가이드를 따르기 위해 작성된 내부 색인 보다 관련성이 높은 친근한 문서 작성 콘텐츠를 두 가지 주요 부분 (초보자 및 작성자 및 작성자에 대한 가이드)으로 세분화합니다.
이 문서는 이미 고급 참여자를 대상으로 하고 있으며, 오픈소스와 장고에 모두 참여하는 신규 및 초보자를 위한 기회를 제공하지 않습니다. 다음은 초보자를 위한 추가 콘텐츠입니다. 다양한 참여자(기술 작가, 디자이너, 개발자)를 안내하는 섹션 타이머 문제와 쉽게 해결할 수 있는 문제를 설명하는 페이지입니다. 현재 문서의 몇 개 섹션을 선택하여 다시 작성하여 초보자 섹션에 추가합니다. 고급 섹션에서 사용된 핵심 요점이나 단어를 설명하는 섹션
타임라인
다음은 Google에서 제공한 캘린더를 사용하여 위에 나열된 프로젝트 목표를 어떻게 달성하고 싶은지에 대한 분석입니다.
커뮤니티 유대감 주간( 8월 17일~9월 13일) 7주차 고급 문서 작성 - 최신 기술 문서 작성 문서에 계속 참여하기 문서에 더 많은 제안 받기 1~4주 차 4주 차 문서의 초보자 섹션 만들기 4주차 - 6주차 권장사항 및 참여자 추천 섹션 작성 1주차 - 6주차 권장사항 및 참여자 추천 섹션 작성 1주~6주 차 추천서 및 참여자 가이드 작성 7주~6주
도구
Sphinx - 현재 문서를 위한 최신 도구입니다. 문서 읽기
이 프로젝트가 필요한 이유
저는 전 세계의 모든 사람을 아우르는 양질의 문서와 기사를 핵심적으로 믿습니다. 그 외에 저는 Django와 오픈소스를 전체적으로 좋아합니다. 저는 초보자로서 Django에 기여하고자 했으며, 이는 제가 좋아하는 도구에 기여할 수 있는 완벽한 방법인 동시에, 개발자(및 테크니컬 라이터)로서 더 많은 기여를 할 수 있도록 코드베이스를 익힐 수 있는 완벽한 방법이라고 생각합니다. 제 관점과 일치하고 제 커리어에 훌륭한 도구가 된 조직과 함께 일하면 즐겁고 아름다울 것입니다.
내가 이 프로젝트에 적합한 담당자인 이유는 무엇인가요?
다음과 같은 계정으로 판단했을 때 제가 적합한 사람입니다. 저는 초보자가 Django 개념을 더 잘 이해할 수 있도록 문서를 작성함으로써 Django에 기여하고 있습니다. 저는 개발자이고 Django에 기여하기를 기대하는 사람으로서 다른 개발자의 필요성과 이를 위해 이를 잘 문서화하는 방법을 알고 있습니다. 저는 팀 플레이어입니다. 저의 멘토 칼튼 깁슨의 감독하에 더 잘 일할 것입니다.