이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 구성:
- Julia 언어
- 기술 문서 작성자:
- Sophb
- 프로젝트 이름:
- FluxML 웹사이트 재설계
- 프로젝트 길이:
- 표준 기간 (3개월)
Project description
이 제안서의 목표는 Flux의 문서 웹사이트를 개선하여 포함된 정보가 신규 사용자와 전문가 모두에게 매력적이고 체계적으로 제공되도록 하는 것입니다. 구체적으로는 기존 문서를 새 섹션으로 재구성하고 Flux 60-mine-blitz 튜토리얼을 확장하여 신규 사용자를 위한 새로운 시작 튜토리얼을 만드는 것이 목표입니다.
이 프로젝트는 다음 단계로 구성됩니다.
기존 문서 웹사이트 분석: 기존 정보를 감사하고 새 튜토리얼을 만들기 위한 정보 스타일 가이드를 정의합니다.
정보의 새로운 구조 정의 및 튜토리얼 시작하기: 멘토와 협력하여 문서 웹사이트의 새로운 섹션과 재구성을 결정합니다. 또한 Flux 60-mine-blitz 튜토리얼을 시작점으로 사용하여 시작 튜토리얼의 목차를 정의하고 이를 토대로 튜토리얼을 작성합니다.
정보 재구성: 이전 단계에서 멘토와 협력하여 정의한 계획으로 웹사이트를 업데이트합니다.
시작하기 튜토리얼 만들기: 첫 번째 초안을 작성하고 검토합니다. 멘토의 의견을 받습니다. 이 문서의 최종 버전이 준비되었다고 판단되면 문서 웹사이트에 게시하겠습니다.
(선택사항) 기존 문서를 리드미 형식에서 HTML로 변환: 4가지 기본 단계를 완료한 후 시간이 남으면 웹사이트에서 더 쉽게 액세스할 수 있도록 리드미 형식의 기존 튜토리얼을 변환할 수 있습니다.
프로젝트 목표를 달성하기 위해 Flux 커뮤니티와 긴밀하게 협력하여 기존 문서를 이해하고 최선의 접근 방식을 결정할 예정입니다. 저도 Julia를 처음 접하는 사용자이므로, 이 정보는 새로운 시작 가이드에 적합한 정보 수준을 결정하는 데 큰 도움이 될 것입니다.
저는 Flux 커뮤니티가 새로운 사용자를 온보딩하는 데 도움이 되는 작업에 집중할 예정입니다. 또한 숙련된 사용자가 새로운 사용 사례를 발견하고 Flux에 관해 자세히 알아볼 수 있도록 지원하는 데 중점을 두겠습니다.