이 페이지는 Cloud Translation API를 통해 번역되었습니다.

전자 프로젝트

이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:: 전자
테크니컬 라이터:: 미스터 골드
프로젝트 이름:: Electron 튜토리얼 흐름
프로젝트 기간:: 표준 기간 (3개월)

Project description

프로젝트 요약

Electron은 자바스크립트, HTML 및 CSS로 교차 플랫폼 데스크톱 앱을 빌드하는 데 널리 사용되는 도구 중 하나입니다. Electron을 기반으로 하는 앱 모음에는 900여 개의 항목이 있으며 이 목록은 계속 늘어나고 있습니다. Visual Studio Code, Atom, Postman, Slack, GitKraken과 같이 널리 사용되는 여러 개발자 도구는 Electron을 기반으로 구축되었습니다.

Electron의 인기는 단순한 학습 곡선과 낮은 진입 기준점에 있습니다. JavaScript, HTML, CSS 스택을 잘 아는 사람이라면 누구나 자신만의 애플리케이션을 빌드할 수 있습니다. 전반적인 성장률이 크게 증가하려면 파악 및 사용하기 쉬운 튜토리얼을 만들고 시작 가이드를 만들어야 합니다.

이 프로젝트의 목표는 Electron 프레임워크를 처음 접하는 애플리케이션 빌더에게 확신을 주고 처음부터 자신만의 Electron 애플리케이션을 개발할 수 있는 일관되고 간소화된 경험을 제공하는 것입니다.

프로젝트 문제

다음은 Electron 튜토리얼 문서와 관련된 가장 중요한 문제의 목록입니다. 1. 애플리케이션 개발 단계와 관련된 시작점이 명확하지 않거나 직관적이지 않은 소개 정보 2. 애플리케이션 개발 프로세스와 관련된 분산된 중복 정보 3. 단일 정보 소스가 없는 정리되지 않은 '시작' 가이드 안내

프로젝트 제안

프로젝트의 목표와 위에서 설명한 문제에 따라 제안된 개선사항 목록은 다음과 같습니다. 1. 기존 가이드를 업데이트합니다. 첫 단계를 원활하고 일관되게 만들기 위해 다음 문서를 단순함에서 더 복잡한 단계로 점진적으로 전환해야 합니다. - 개발자 환경 - 첫 번째 Electron 앱 작성 - 앱에 기능 추가 (요약 페이지 만들기) - 앱 패키징 및 배포 2. 문서 디렉터리를 재구성합니다. 시작하는 데 필수적인 사항과 추가 단계로 간주할 수 있는 작업을 신규 개발자에게 보여주려면 문서 페이지에 첫 번째 애플리케이션을 최대한 빠르게 게시하도록 단계의 시각적 및 상황별 구분이 모두 있어야 합니다. 재구성에는 가능한 다음 단계에 대한 안내도 포함됩니다. 3. 애플리케이션 개발 문서를 구성하고 통합합니다. 모든 기능에는 앱 설치/사용 설정 방법, 빠른 시작 방법, 최초 실행 후 앱 사용 방법, 배포 방법에 관한 통합 지침이 있어야 합니다. 4. 문서에 electron-api-demos 저장소를 포함합니다. electron-api-demos 저장소에는 Electron 애플리케이션에 기능을 추가하는 방법을 보여주는 일련의 예가 있습니다. 단일 정보 소스 콘텐츠 전략과 일관되도록 이 정보는 앱에 기능 추가 가이드에 포함되어야 합니다. 5. 문서에 Electron Fiddle 예시를 통합합니다. 이 단계를 통해 신규 개발자는 단계를 수동으로 반복하지 않고도 특정 코드의 작동 방식을 더 쉽게 확인할 수 있습니다. 통합에는 업데이트된 튜토리얼을 위한 코드 샘플을 작성하고 코드 블록에 'Launch in Fiddle' 버튼을 추가하는 작업이 포함됩니다.

경기 하이라이트

신청 검토 기간 - 함께 작업할 커뮤니티 및 사람들에 대해 익힙니다. 커뮤니티 자막 제공 가이드 및 권장사항을 알아보세요. 가장 먼저 참여하세요. 커뮤니티 유대감 형성 - 커뮤니티를 탐색하세요. Electron 문서의 현재 상태를 검사합니다. 약점을 파악합니다. 1주 차 - 프로젝트 주요 일정 및 결과물에 관해 멘토와 조율하기 2주 차 - 개발자 환경 수정 및 첫 번째 Electron 앱 페이지 작성 3주 차 - 애플리케이션 아키텍처 수정, 앱에 기능 추가, 앱 패키징 및 배포 페이지 앱에 추가할 수 있는 기능 목록이 포함된 요약 페이지를 만듭니다. 4주 차 - 문서 디렉터리 재구성 5주 차 - electron-api-demos를 기본 문서에 통합하는 방식에 대한 템플릿 준비 6~7주 차 - electron-api-demos 저장소 이전 8주 차 - Electron Fiddle 기본 문서 통합 방식 템플릿을 준비합니다. 첫 번째 샘플을 작성합니다. 9~10주 차 - Electron Fiddle을 기본 문서에 통합 11주 차 - electron-api-demos 저장소와 Electron Fiddle 샘플을 이전한 후 기본 문서 구조 및 페이지 수정 12주 차 - 결과 평가

주요 성과 분석

신청 검토 기간 기간의 첫 번째 기간은 커뮤니티 채널과 소스 코드를 확인하고 프로젝트 전담 담당자에게 연락하는 데 사용됩니다.

기간의 후반부에서는 일반적인 참여 문화를 점검하고 참여 가이드 및 권장사항을 살펴보는 시간을 가질 예정입니다. 처음으로 참여가 흐름이 어떻게 작동하는지 확인하는 시점입니다.

커뮤니티 유대감 형성

이번에는 문서 폴더와 로드맵을 더 자세히 살펴보는 시간을 가집니다. 이 정보를 바탕으로 개선의 여지가 있는 약점 (예: 불완전하거나 누락된 부품)을 파악할 수 있습니다. 가능한 경우 pull 요청을 만들어 공백을 메웁니다.

1주 차 - 2주 차

첫째 주에는 멘토와 소통하며 예상되는 일정과 시기적절한 결과를 조율하는 시간을 가집니다.

두 번째 주에는 개발자 환경을 수정하고 첫 번째 Electron 앱 페이지를 작성하는 방법을 알아봅니다. 개발자 환경 페이지의 경우 일반 개요 및 교정을 다시 작성할 수 있습니다. 첫 번째 전자 앱 작성 페이지의 경우 페이지를 명확한 시작점과 끝점이 있는 일관적인 단계별 가이드로 만들고 중복 정보 (예: Nutshell의 전자 개발 및 이 예시 섹션 사용해보기)의 유사한 코드 블록 2개를 삭제하는 작업이 포함됩니다.

결과물: Electron 애플리케이션으로 빠른 시작을 수행하는 방법에 대한 소개 가이드가 수정되었습니다.

3주 차

이번 주에는 주요 내용을 살펴보겠습니다. 1. 애플리케이션 아키텍처 페이지의 개선사항 여기에는 다음과 같은 작업이 포함됩니다. - 처음 읽는 사용자에게 더 간단하고 직관적으로 메인 및 렌더기 프로세스 섹션의 기존 정보 재작성 - 아키텍처, 프로세스 연결 방식, 통신 방식 및 핵심 차이점을 시각적으로 표현하는 기능 추가 시각 자료의 예: 하나, 둘, 셋 (낮은 품질) 2. Electron 애플리케이션에 추가할 수 있는 모든 기능에 대한 정보 통합 여기에는 기능 설치/사용 설정 방법에 관한 통합 안내와 기능 작동 방식의 예를 확인할 수 있도록 가이드를 다시 작성하는 것이 포함됩니다. 또한 사용할 수 있는 모든 기능을 나열하는 새 페이지 (요약)가 생성됩니다. 통합된 안내는 다음과 같습니다. - 개요 - 예: - 코드 샘플 - 시각적 예 (가능한 경우)

간소화하겠습니다. 여기에는 다음 작업이 포함됩니다. a. 애플리케이션 패키징을 애플리케이션 배포 가이드에 병합 b. 배포 방법을 자동 및 수동으로 구분 c. 자동 배포의 예로 전자 대장 활용 d. 애플리케이션 패키징 페이지에서 asar에 대한 정보를 가져오고 소스 파일 복사 및 수동 배포의 예로 Asar 보관 파일 만들기에 대해 설명합니다. #### 4주 차 이번 주에는 문서 디렉터리 구조를 변경하는 작업이 진행됩니다. 다음과 같은 항목이 포함됩니다.

1 - 기존 가이드를 다음 세 가지 이상의 카테고리로 나눕니다. a. 빠른 시작 b. 기본사항 학습 c. 고급 단계

빠른 시작 카테고리에는 기본 튜토리얼 (설치, 구성, 배포)이 포함되어 있어 초보자가 처음부터 쉽게 시작할 수 있도록 일련의 일관된 가이드를 만들 수 있습니다. 각 가이드에는 시리즈의 이전/다음 가이드에 대한 링크가 포함되어야 합니다.

구조는 다음과 같습니다. 1. 기본 요건 2. Electron을 설치합니다. 3. 기본 애플리케이션을 만듭니다. 4. 애플리케이션 패키징/배포

빠른 시작 섹션을 완료하고 나면 사용자는 Electron 애플리케이션의 작동 방식에 대한 기본 사항을 이해하게 되며 완전히 작동하는 배포 가능한 Electron 애플리케이션을 갖추게 됩니다.

기본사항 학습 카테고리에는 Electron에 대한 지식을 강화하고 빠른 시작 섹션에서 만든 애플리케이션을 확장하기 위한 가이드가 포함됩니다. 이 가이드에는 다음이 포함됩니다. - 애플리케이션 아키텍처 - 앱에 기능 추가 - 상용구 및 CLI

고급 단계 카테고리에는 Electron 애플리케이션을 구성하고 미세 조정하는 데 유용한 고급 가이드가 포함됩니다. - 테스트 및 디버깅 - 접근성 - 보안 - 업데이트

2 - 문서 페이지 수를 줄입니다. 현재 버전의 설명서에는 어느 정도 겹치는 콘텐츠와 분류되지 않은 안내가 포함되어 있습니다. 예: - 첫 앱 작성 내에서 Electron 설치 및 설치 - 애플리케이션 배포 내에서 애플리케이션을 패키징하고 파일로 패키징 - 세부정보 및 고급 카테고리에서 분류되지 않은 안내: 제안: 다음 문서를 GitHub로 이동하고 기본 문서에서 제외합니다. 이러한 문서는 Electron 개발 가이드라인에만 적용되며, 소스 저장소는 가장 먼저 소스 저장소를 찾아볼 수 있습니다. - Electron 개발 - Chromium 개발 - V8 개발 - Electron의 문제 - Electron의 패치 - 가져오기 요청 - 소스 코드 디렉터리 구조 - 테스트 - 코딩 스타일

이러한 감소의 주요 아이디어는 사용 가능한 가이드 수가 많지 않고, 여기저기 흩어져 있는 퍼즐 조각들을 결합하고, 초보자에게 보다 체계적이고, 쉽게 탐색할 수 있으며, 사용자 친화적인 버전의 Electron 문서를 제공하는 것입니다.

5~7주

5주 차는 electron-api-demos를 기본 문서에 통합하는 방법에 대한 템플릿 (방법)을 준비하는 것입니다. 이 템플릿은 다음과 같이 표시될 수 있습니다. 1. 기본 문서의 '앱에 기능 추가'에서 electron-api-demos에 표시된 카테고리를 만듭니다. 2. 각 카테고리를 살펴보면서 데모 예시를 기본 문서로 전송합니다. - 소스 코드 또는 애플리케이션의 해당 기능 설명에서 코드 샘플을 가져올 수 있습니다. - 전송된 각 예시 뒤에 관련 설명이 와야 합니다. - 각 하위 예 (예: 시스템 사용 대화상자의 하위 요소로서의 오류 대화상자)는 상위 요소 아래로 전송되어야 합니다.

참고 #1: electron-api-demos 및 기본 문서 (예: 단축키, 드래그 앤 드롭) 모두에 이러한 예가 있습니다. 이 경우 electron-api-demos의 예는 우선순위를 가져야 하며 기본 문서에 있는 예는 무시해야 합니다.

참고 #2: electron-api-demos 애플리케이션의 많은 예에는 설명된 기능의 실시간 데모 미리보기가 있습니다. 이 기능은 9~10주 차에 Electron Fiddle 통합이 완료될 때까지 무시됩니다.

새로운 계층 구조 예시에 따라 3주 차에 생성된 기능을 사용할 수 있는 모든 기능 (3주 차에 생성됨)이 나열된 페이지를 업데이트합니다.

6주 차와 7주 차에는 위에 설명된 템플릿에 따라 electron-api-demos 예제를 기본 문서로 전송하는 데 사용됩니다. 마지막 단계로 electron-api-demos 저장소를 삭제하거나 지원 중단해야 합니다.

8~10주

8주 차에는 Electron Fiddle이 기본 문서에 통합되는 방식에 대한 템플릿을 준비합니다. 이 이니셔티브는 커뮤니티 자원봉사자와 Electron 담당자에 의해 이미 시작되었지만 (문제 #20442에서 세부정보 확인) 적절한 확정이 필요합니다.

Fiddle 샘플을 계속 진행하기 위한 기본 템플릿은 다음과 같습니다. 1. 기본 문서에서 예시 (예: 빠른 시작)를 선택합니다. 이제 문서에 electron-api-demos 예도 포함되어야 합니다. 2. Electron Fiddle에서 예시를 다시 생성합니다 (예시 코드 또는 소스 코드를 시작점으로 사용). 3. Fiddle을 폴더에 로컬로 저장합니다. 4. 예시를 /docs/fiddles/[CATEGORY]/[SECTION]/[DEMO]로 옮깁니다. * 완성된 예시 목록은 문제의 '데모 목록' 섹션에 설명되어 있습니다. 5. 문제 #2848의 첫 댓글에 설명된 대로 'Launch in Fiddle' 버튼을 추가합니다.

9주 차와 10주 차는 위에서 설명한 템플릿에 따라 이미 Fiddles로 변환된 electron-api-demos 예제를 기본 문서에 통합하는 것입니다.

11주 차

이번 주에는 electron-api-demos 저장소와 Electron Fiddle 샘플을 성공적으로 이전한 후 작성 프로젝트를 마무리하는 시간을 갖겠습니다. 여기에는 다음이 포함됩니다. - 모든 기존 코드 예제에 'Fiddle에서 실행' 버튼이 있는지 확인 - 모든 기존 코드 예제가 Fiddle로 제대로 작동하는지 확인 - 기본 문서에서 더 이상 electron-api-demos 저장소를 참조하지 않는지 확인

12주 차

완료된 작업 마무리 승인 확인