이 페이지에는 Google 시즌의 Docs에 승인된 기술 글쓰기 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 구성:
- Django
- 테크니컬 라이터:
- Gabbyprecious
- 프로젝트 이름:
- 더 사용자 친화적이고 쉽게 탐색할 수 있도록 참여 가이드를 다시 작성합니다.
- 프로젝트 길이:
- 표준 기간 (3개월)
Project description
추상
다른 모든 문서와 마찬가지로 Django 참여 가이드의 목표는 사용자, 오픈소스 기여자에게 Django의 지속 가능성과 발전에 어떻게 어떻게 기여할 수 있는지 안내하는 것입니다.
문서를 작성해야 하는 경우는 항상 있습니다. 특히 커뮤니티와 Django 자체에 큰 영향을 미치는 문서가 그렇습니다.
Django의 올해 Google 프로그래밍 경진대회(Summer of Docs)는 참여 가이드의 부담을 줄여주고 참여자의 환영과 참여를 유도하는 것을 목표로 합니다. 이는 참여자를 장려하는 데 필수적인 목표이며, 저도 이 훌륭한 프레임워크에 참여하기 시작할 때 이러한 목표를 세웠습니다.
현재 상태
여기에서 확인할 수 있는 현재 문서는 너무 방대하고 구조가 잘 잡혀 있지 않아 Django의 참여에 대한 이해가 부족해지고 신규 참여자를 환영하지 않는 것처럼 보일 수 있으므로 가이드로서의 역할이 크지 않습니다.
프로젝트 목표
포럼에서 제 멘토인 Carlton Gibson과 문서에 대한 제 제안사항을 논의했으며, 그는 현재 문서의 어려운 문제를 해결하는 데 도움이 될 것이라는 데 동의합니다. 문서 재구성의 목표는 다음과 같습니다. 문서 재구성 섹션 권장사항 및 금지사항 추가 기능 요청 및 만들기와 같은 사소한 섹션 단일 페이지를 만듭니다. 짧은 일반 문서 및 요점 문서 새 가이드를 따르기 위해 작성된 내부 색인 새 가이드를 따르기 위해 작성된 내부 색인 콘텐츠를 두 개의 주요 부분 (초보자/작성자 기준 작성, 작성자를 위한 문서 작성 및 고급 가이드 작성)으로 세분화
현재 문서는 이미 고급 참여자를 대상으로 하고 있지만 오픈소스와 Django의 신규 및 초보자 참여자는 참여할 수 없습니다. 다음은 초보자를 위한 추가 콘텐츠입니다. 다양한 참여자(테크니컬 라이터, 디자이너, 개발자)를 안내하는 섹션 초기 타이머 문제와 해결할 수 있는 쉬운 문제를 문서화하는 페이지입니다. 현재 문서에서 몇 가지 섹션을 학습한 다음 다시 써서 초보자 섹션에 추가합니다. 고급 섹션에서 사용된 주요 요점이나 단어를 설명하는 섹션입니다.
타임라인
Google에서 제공한 캘린더를 통해 위에 나열된 프로젝트 목표를 어떻게 달성할지 자세히 설명하겠습니다.
커뮤니티 결속 주( 8월 17일~9월 13일) 커뮤니티와 더 많이 소통합니다. 문서에 계속 기여합니다. 참여자로부터 더 많은 제안을 받습니다. 현재 문서 및 의도한 도구에 대해 더 많이 학습합니다. 1주차~4주차: 수준에 따라 문서 섹션을 시작합니다. 문서의 초보자 섹션을 만듭니다. 4주차~6주차: 권장사항 및 금지사항을 선별합니다. 섹션별 권장사항 및 금지사항을 작성합니다. 섹션의 추가 페이지를 만듭니다. 7주차~9주차: 현재 문서를 수정하여 고급 참여자 가이드로 이동합니다. 문서를 축소합니다. 10주차~12주차: 용어집을 준비합니다. 내부 색인을 새 문서로 업데이트합니다. 신규 기술 작가/참여자를 위한 가이드 및 스타일을 만듭니다.
도구
Sphinx - 현재 문서 작성에 사용되는 도구입니다. 문서를 읽으세요.
프로젝트 목적
저는 전 세계 모든 사용자를 포용하기 위해 잘 작성된 문서와 도움말을 제공하는 것이 중요하다고 생각합니다. 그 외에도 Django와 오픈소스를 전반적으로 좋아합니다. 저는 초보자로서 Django에 기여하고 싶었으며, 이 리뷰는 제가 좋아하는 도구에 기여하는 동시에 코드베이스를 숙지하여 개발자(및 기술 문서 작성자)로서 더 많은 기여를 할 수 있는 완벽한 방법이라고 생각합니다. 저의 견해와 일치하고 제 커리어 전체에 훌륭한 도구가 된 조직과 함께 일하는 것은 즐겁고 아름답습니다.
이 프로젝트에 적합한 이유
다음과 같은 이유로 제가 적합한 사람이라고 생각합니다. 초보자가 Django의 개념을 더 잘 이해할 수 있도록 도움을 주는 도움말을 작성하여 Django에 기여해 왔습니다. Django에 기여하고자 하는 개발자로서 동료 개발자의 필요성과 이를 위해 효과적으로 문서화하는 방법을 잘 알고 있습니다. 저는 팀워크가 뛰어나며 멘토인 칼튼 깁슨의 감독을 받으면 잘할 수 있습니다.