Linux Foundation 프로젝트

이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 구성:

Linux Foundation

테크니컬 라이터:

샤오야

프로젝트 이름:

CHAOSS D&I 배지 프로젝트를 위한 빌드 문서

프로젝트 기간:

표준 기간 (3개월)

Project description

다음과 같이 주요 콘텐츠를 작성했습니다. 기본 목표는 워크플로 내에서 문서 관련 작업을 보강하고, 커뮤니티 대상 D&I 배지 문서를 작성하고, 전문 플랫폼에서 다국어로 처리된 문서를 호스팅하는 것입니다. 이는 다음과 같은 마이크로 태스크로 구분할 수 있습니다. D&I 측정항목을 더 많이 사용하도록 현재 PR 템플릿을 업데이트하고 통합하며 질문을 다양화합니다. D&I 배지 프로그램 소개를 위한 개념적 개요 초안 JOSS 문서를 참고하여 신청자 가이드라인 초안 작성 JOSS 문서를 참고하여 검토자 가이드라인 초안 작성 워크플로 전반에서 다양한 역할과 각 역할의 책임을 설명하는 문서 워크플로에 GitHub probot이 적용되는 방식을 설명하는 문서 신규 사용자가 프로젝트 또는 문서에 참여하는 방법을 보여주는 참여자 가이드라인 문서 번역 작업을 지원하고, 특히 중국어의 자동 번역 성능을 확인하며, 필요한 경우 수동 번역 작업을 수행합니다. 번역 작업에 따라 다국어 형식으로 문서를 구성합니다. Gitbook, Read the Doc 또는 GitHub Wiki를 사용하여 문서를 호스팅합니다.

결과물 1. 더 많은 측정항목과 다양한 질문으로 프로젝트 및 이벤트 PR 템플릿을 강화합니다. 이 결과물에는 워크플로 내의 모든 문서 관련 작업, 특히 신청자가 작성하도록 준비된 PR 템플릿이 포함됩니다. 이 템플릿은 검토자 평가에 결정적인 역할을 하기 때문에 워크플로의 핵심 구성요소라고 생각합니다. 따라서 워크플로를 구성하는 과정에서 질문의 양식과 내용이 완성될 것입니다. 이를 다음과 같은 관점에서 전달할 예정입니다. 다양한 유형의 이벤트 또는 프로젝트를 기반으로 하는 것 더 많은 D&I 측정항목과 결합하는 것 증거 기반 답변을 요구하는 다양한 질문 방식을 사용하는 것

결과물 2.

결과물 3. 문서를 여러 언어 형식으로 구성하고 Read the Docs 또는 Gitbook과 같은 플랫폼에 호스팅합니다.

현재 워크플로에서는 일부 자동 번역 작업이 연구되고 있습니다. 특히 중국어의 경우 번역의 정확성 및 유창성과 같은 번역 결과가 얼마나 잘 수행되는지 확인하는 데 도움을 드리겠습니다. 문서는 형식으로 존재하며 Read the Docs, Gitbook, GitHub 위키와 같은 기술 문서 호스팅 플랫폼을 조사하고 오픈 커뮤니티용 문서를 호스팅하는 데 가장 적합한 플랫폼을 선택합니다.