이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- Linux Foundation
- 테크니컬 라이터:
- 샤오야
- 프로젝트 이름:
- CHAOSS D&I 배지 프로젝트 문서 작성
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
주요 목표는 워크플로 내에서 문서 관련 작업을 보강하고, 커뮤니티 대상 D&I 배지 문서를 작성하며, 전문 플랫폼에 다국어로 처리된 문서를 호스팅하는 것입니다. 이러한 문서는 다음과 같은 마이크로 작업으로 분리할 수 있습니다. 더 많은 D&I 측정항목과 다양한 질문을 사용할 수 있도록 현재 PR 템플릿을 업데이트하고 통합합니다. D&I 배지 프로그램 소개를 위한 개념 개요 작성 JOSS 문서를 참조로 사용하여 Applier 가이드라인 초안 작성 JOSS 문서를 참고 자료로 사용하여 검토자 가이드라인 초안 작성 워크플로 전반에 걸쳐 다양한 역할과 각 책임을 설명하는 문서 워크플로에 GitHub probot이 적용되는 방식을 설명하는 문서 신규 사용자가 프로젝트 또는 문서에 기여할 수 있는 방법을 보여주는 기여자 가이드라인입니다. 문서 번역 작업을 돕고, 특히 중국어의 자동 번역 성능을 확인하고 필요한 경우 수동 번역 작업을 수행합니다. 번역 작업에 따라 다국어 형식으로 문서를 구성합니다. Gitbook, Read the Doc 또는 GitHub Wiki를 사용하여 문서를 호스팅합니다.
결과물 1. 더 많은 측정항목과 다양한 질문을 사용해 프로젝트 및 이벤트 홍보 템플릿 보강 이 결과물에는 워크플로 내의 모든 문서 관련 작업, 특히 신청자가 완료할 수 있도록 준비된 PR 템플릿이 포함됩니다. 이 워크플로는 검토자 평가에서 결정적인 역할을 하므로 워크플로의 핵심 구성요소라고 생각합니다. 따라서 워크플로의 구성 전반에 걸쳐 질문의 형식과 내용이 완성됩니다. 저는 다음과 같은 지점에서 이를 제공할 것입니다. 다양한 유형의 이벤트 또는 프로젝트의 답변을 기반으로 질문의 다양성, D&I 관련 질문에 대한 다양성 증명 및
결과물 2. 다음은 커뮤니티 대상 문서 구조 초안입니다.
D&I 배지 검토 개요
소개
목표
배지 등급
배지 신청
이벤트 배지 신청
이벤트 PR 템플릿
프로젝트 배지 신청
프로젝트 PR 템플릿
검토
검토자가 되는 방법
D&I 배지 지정 관심분야 정책
검토 기준
D&I 배지 지정 및 관심분야 정책 검토
기준 검토 - 역할 및 책임 검토
PR 담당자 지정 및 검토 결과
PR 담당자 지정 및 책임 검토 방법
PR 담당자
결과물 3. 문서를 다국어 형식으로 정리하고 문서 읽기 또는 Gitbook과 같은 플랫폼에 호스팅합니다.
현재 워크플로에서 일부 자동 번역 작업을 살펴보고 있으며, 특히 중국어 번역의 정확성과 유창함과 같이 번역 결과가 얼마나 잘 작동하는지 확인할 수 있도록 도와드리겠습니다. 문서는 형식으로 존재하며, 문서 읽기, Gitbook, GitHub 위키와 같은 기술 문서 호스팅 플랫폼을 살펴보고 공개 커뮤니티용 문서를 호스팅하는 데 가장 적합한 플랫폼을 선택할 것입니다.