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

전자 프로젝트

이 페이지에는 Google 시즌의 Docs에 승인된 기술 글쓰기 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 구성:: Electron
기술 문서 작성자:: 미스터 골드
프로젝트 이름:: Electron 튜토리얼 흐름
프로젝트 길이:: 표준 기간 (3개월)

Project description

프로젝트 요약

Electron은 JavaScript, 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주차: 결과 평가

주요 목표의 세부사항

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

두 번째 기간에는 일반적인 참여 문화를 확인하고 참여 가이드 및 권장사항을 검토하는 데 전념할 예정입니다. 이때 처음으로 참여하여 절차가 어떻게 진행되는지 확인할 수 있습니다.

커뮤니티 결속

이 시간에는 로드맵과 함께 문서 폴더를 심도 있게 살펴보겠습니다. 이러한 정보를 바탕으로 개선이 필요한 약점 (예: 불완전하거나 누락된 부분)을 식별할 수 있습니다. 가능한 경우 빈틈을 메우기 위해 풀 요청을 만듭니다.

1주차 - 2주차

첫 번째 주에는 예상되는 주요 기록과 적시에 달성하기 위한 멘토와의 커뮤니케이션에 집중합니다.

두 번째 주에는 개발자 환경 수정 및 첫 번째 Electron 앱 작성 페이지를 다룹니다. 개발자 환경 페이지의 경우 일반적인 개요를 다시 작성하고 교정합니다. 첫 번째 Electron 앱 작성 페이지의 경우 페이지를 명확한 시작점과 끝점이 있는 일관된 단계별 가이드로 만들고 중복된 정보 (예: Electron 개발 개요 및 이 예시 사용하기 섹션 아래의 유사한 두 코드 블록)를 삭제합니다.

결과물: Electron 애플리케이션으로 빠르게 시작하는 방법에 관한 간단한 소개 가이드가 수정되었습니다.

3주 차

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

애플리케이션 배포 페이지 간소화 여기에는 다음이 포함됩니다. a. 애플리케이션 패키징을 애플리케이션 배포 가이드에 병합하기 b. 배포 방법을 자동 및 수동으로 나누기 c. electron-forge를 자동 배포의 예로 들기 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의 패치 - pull 요청 - 소스 코드 디렉터리 구조 - 테스트 - 코딩 스타일

이번 축소의 주된 목적은 사용 가능한 가이드의 과도한 수를 없애고 흩어진 정보의 퍼즐 조각을 하나로 모으고 신규 사용자에게 더 구조적이고 쉽게 탐색할 수 있으며 사용자 친화적인 버전의 Electron 문서를 제공하는 것입니다.

5~7주

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

참고 #1: electron-api-demos와 기본 문서에 모두 있는 예시가 있습니다 (예: 단축키, 드래그 앤 드롭). 이 경우 electron-api-demos의 예시가 우선 적용되고 기본 문서의 예시는 무시되어야 합니다.

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

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]/[섹션]/[DEMO]로 옮기세요. * 완성된 예시 목록은 문제의 '데모 목록' 섹션에 설명되어 있습니다. 5. 문제 #2848의 최초 댓글에 설명된 대로 'Launch in Fiddle' 버튼을 추가합니다.

9주차와 10주차에는 위에서 설명한 템플릿에 따라 electron-api-demos 예시 (이미 Fiddle로 변환됨)를 기본 문서에 통합하는 데 전념할 예정입니다.

11주 차

이번 주에는 electron-api-demos 저장소와 Electron Fiddle 샘플을 성공적으로 이전한 후 작성 프로젝트를 완료하는 데 전념할 예정입니다. 여기에는 다음과 같은 작업이 포함됩니다. - 모든 기존 코드 예시에 'Fiddle에서 실행' 버튼이 있는지 확인 - 모든 기존 코드 예시가 Fiddles로 제대로 작동하는지 확인 - 기본 문서에서 더 이상 electron-api-demos 저장소를 참조하지 않는지 확인

12주 차

완료된 작업의 마무리 수락 확인