이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- LLVM 컴파일러 인프라
- 테크니컬 라이터:
- DR87
- 프로젝트 이름:
- LLVM 문서 색인 및 문서 스타일 가이드 재구성
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
이 프로젝트에는 다음 작업이 포함됩니다.
a.) 문서 색인 페이지를 재구성하여 더 사용자 친화적인 환경을 제공합니다. 이 작업에서는 현재 페이지를 평가하고 독립적인 조사, SME 인터뷰, 사용자 의견을 종합적으로 고려하여 페이지를 재구성합니다. 가능한 옵션에는 간단한 설명 수정, 기존 페이지 재구성, 점진적인 정보 공개 모델을 통한 추가 레이어 (페이지) 추가가 있습니다. 이렇게 하면 기본 색인 페이지에 표시되는 링크의 수가 줄어 사용자가 특정 정보/가이드를 더 쉽게 찾을 수 있습니다. 예를 들어 색인에는 LLVM 설계 및 개요, 사용자 가이드, 하위 시스템 문서, 개발 프로세스 문서의 별도 페이지 링크가 포함될 수 있습니다.
b.) 오픈소스 참여자를 위한 LLVM Sphinx 스타일 가이드를 업데이트합니다. 여기에는 최신 가이드를 평가하고, 독립적인 조사 및 SME 인터뷰를 통해 차이를 식별하고, 합의된 요구사항에 따라 가이드를 업데이트하는 작업이 포함됩니다. 업데이트에는 가이드의 레이아웃 재구성, 새 콘텐츠 추가, 관련 페이지 링크(예: 참여자 가이드) 삽입이 포함될 수 있습니다. 최종 목표는 자원봉사자가 최대한 빨리 손쉽게 기부를 시작할 수 있도록 돕는 것입니다.