이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- 크리에이티브 커먼즈
- 테크니컬 라이터:
- JackieBinya
- 프로젝트 이름:
- WordPress 기본 테마 사용 가이드
- 프로젝트 기간:
- 표준 기간 (3개월)
Project description
GSOD-2020의 테크니컬 라이터 신청 단계에서 크리에이티브 커먼즈 WordPress 기본 테마 문서 프로젝트의 멘토인 휴고 솔라와 여러 번 상호작용했습니다.
처음 연락했을 때 WordPress 기본 테마 사용 가이드를 만드는 목적을 이해하는 데 도움이 필요했습니다. 그는 매우 유익한 정보를 얻어 빠르게 제 프로젝트를 시작하게 해 주었습니다. 그 후로 이어지는 모든 상호작용은 CC WordPress Base 테마 문서의 목표를 다듬는 것이었습니다.
이 단계에 도달하면 프로젝트의 요구사항과 목표를 이해하고 있다고 느낀 다음 CC WordPress 기본 테마 사용 가이드를 위한 제안서 초안을 작성했습니다.
이 제안서는 인턴 지원용 크리에이티브 커먼즈 공식 템플릿을 사용하여 작성되었습니다. 프로젝트 개요, 제안된 프로젝트 구조, 새 WordPress Base Theme 문서의 레이아웃에 관한 정보와 문서 생성 단계의 타임라인 및 결과물에 관한 정보를 제공합니다.
그런 다음 Hugo Solar는 제안 초안을 검토하고 개선을 위한 의견을 제공했습니다. 이 과정을 진행하는 동안 그는 항상 프로젝트에 대한 질문에 답할 수 있었습니다.
제공된 의견을 구현했으며 건물 D&I 배지 지정 문서에 대한 최종 제안을 아래 링크에서 Google 문서로 확인할 수 있습니다.
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
또는 아래에 나와 있는 제안서 요약 정보를 참고하세요.
크리에이티브 커먼즈 - WordPress 기본 테마 사용 가이드 재클린 비냐가 작성한 제안서, 2020년 6월 28일
프로젝트 시놉시스 이 프로젝트의 궁극적인 목표는 크리에이티브 커먼즈 WordPress Base Theme에 관한 풍부하고 직관적이며 흥미로우며 아름답게 표현된 커뮤니티용 문서를 만드는 것입니다.
프로젝트 계획 문제 현재 크리에이티브 커먼즈 WordPress Base 테마에는 문서가 없어 커뮤니티 내에서 테마를 효과적으로 사용하는 데 방해가 되고 있습니다. 제 목표는 테마에 관한 전체 사용 가이드를 만들고 WP 기본 테마의 현재 코드베이스에 추상화를 구현하여 테마를 더 쉽게 사용할 수 있도록 하는 것입니다.
솔루션: Gatsby와 같은 최신 프레임워크를 사용하여 미래 지향적인 문서를 작성합니다. Gatsby에는 새로운 WordPress Base Theme 문서를 부트스트랩하는 데 사용할 수 있는 시작 조건이 있습니다. 시작 조건의 예로는 검색엔진 최적화(SEO), 마크다운, 정적 사이트의 검색을 위해 통합되는 도구인 Algolia가 기본적으로 제공되는 gatsby-gitbook-starter가 있습니다. 또한 Gatsby에서 생성한 모든 사이트는 국제화 및 접근성을 통합하도록 쉽게 최적화할 수 있습니다. 문서를 작성할 때 가능한 한 직관적으로 만들고자 합니다. - 이해하기 쉬운 방식으로 문서를 작성하고 모호함과 과도하게 복잡한 기술 전문용어를 사용하지 않도록 주의를 기울입니다. - 그래픽 삽화와 미디어를 문서에 통합하여 학습을 위한 시각 자료로 사용합니다. - 맞춤설정과 같은 일반적인 작업을 실행하는 방법을 보여주는 예제 사용
제가 구현하고자 하는 추상화에는 예를 들어 후크와 같은 WP 기본 테마의 핵심 기능을 사용자가 WordPress 관리 패널에서 활용할 수 있도록 하는 것이 포함됩니다. 또한 별도의 저장소에 WP Base Theme의 시작 하위 테마를 만들고 싶습니다. 초보자용 하위 테마를 사용하면 신규 사용자에게 더 원활하고 빠른 온보딩 환경을 제공할 수 있습니다. 서류 작성이 완료되고 승인되면 문서가 게시되고 온라인에 호스팅됩니다.
CC WordPress 기본 테마 사용 가이드의 제안된 구조 - 제안된 문서는 아래 나열된 여러 섹션으로 나뉩니다. 그런 다음 각 제안된 섹션 아래의 하위 목록 항목은 각 섹션에서 찾을 수 있는 실제 콘텐츠에 대한 세부정보를 제공합니다.
개요 섹션 - 크리에이티브 커먼즈(CC) WordPress 기본 테마의 정의, 의도 및 기능을 간략히 설명합니다. * 정의: CC WP 기본 테마를 간략하게 설명합니다. * 의도: CC WP 기본 테마의 목표/ 의도를 서술합니다. * 특징: CC WP 기본 테마의 기능을 간략히 설명합니다.
시작하기 섹션 - 요구사항 * CC WordPress 기본 테마(예: WordPress 버전) - PHP 버전 - Composer 등 - 설치 가이드 * zip을 사용하여 CC WordPress 테마를 설치하는 방법을 간략히 설명합니다. * GitHub에서 WP 기본 테마를 복제하여 사용자가 시작할 수 있는 방법을 간략히 설명합니다. * 사용자가 프로젝트에 종속 항목을 설치하는 방법을 간략히 설명합니다. * 사용자가 종속 항목 Queulat를 구성하는 방법을 설명합니다. * 사용자가 현지 WordPress 개발 환경에서 테마를 활성화하는 방법을 설명합니다.
사용 가이드 - 개요 * 하위 테마 용어 설명 * 하위 테마 사용의 이점을 설명합니다. * 사용자에게 권장된 WP 기본 테마 수정 방법은 하위 테마를 사용하는 것이라고 알립니다. * 사용자가 하위 테마를 만들기 전에 먼저 WP Base Theme을 설치하고 활성화해야 한다는 점을 강조합니다.
하위 테마 사용 - 사용자가 시작 조건을 사용하여 WP 기본 테마의 하위 테마를 만드는 방법을 설명합니다. 동영상을 사용하여 사용자가 시작 조건에서 하위 테마를 만드는 방법을 설명합니다.
맞춤설정 아래 하위 섹션에서는 WordPress 맞춤설정 도구와 WordPress 관리 패널을 사용하여 맞춤설정하는 방법을 설명합니다. 또한 그래픽 일러스트를 사용하여 설명을 더 직관적으로 만들 것입니다. - 사이트 설명 또는 소개 문구를 맞춤설정합니다. - 맞춤 탐색 메뉴 - CSS 맞춤설정 - 페이지 추가 - 게시물 추가 - 위젯 - WordPress 관리 패널에서 위젯 추가 및 삭제 - 맞춤설정 도구를 사용해 실시간 미리보기와 위젯 추가
고급 맞춤설정 섹션 - CSS 섹션 맞춤설정 * 테마 스타일 지정을 구성하는 구성요소를 설명합니다. - CC 용어 - Bulma - Sass * 프로젝트에서 Sass가 설정된 방식을 설명합니다. 설명에는 다음 정보가 포함되어야 합니다. (i) 프로젝트 구조 내 sass 파일 위치 (ii) sass 빌드 및 시청에 사용할 수 있는 npm 스크립트 * 하위 테마에서 sass 스타일을 맞춤설정하는 방법, 즉 특정 npm 종속 항목 설치를 통해 사용자가 하위 테마에서 sass 스타일을 맞춤설정하는 방법 * 구성요소 클래스 (class-component.php)를 사용하여 특정 구성요소의 스타일 맞춤설정 방법 설명
- 후크 섹션
개요
- 유인 요소라는 용어 설명
- 사용자가 후크를 활용해야 하는 이유를 설명합니다.
- 사용 가능한 후크 유형을 간략히 설명합니다.
작업 사용
- WP 기본 테마에서 사용 가능한 작업 및 위치 나열
- 이러한 조치를 어떻게 구현할 수 있는지 설명합니다.
*필터 사용하기 - 테마에서 사용할 수 있는 필터를 나열하고 필터를 구현하는 방법을 설명합니다.
테마 섹션 업데이트 - 사용자가 테마를 업데이트하는 방법을 설명합니다.
라이선스 섹션 * 개인 프로젝트에서 CC WP Base Theme을 사용하려는 사람들에게 프로젝트 라이선스와 이것이 의미하는 바를 설명합니다.
참여 섹션 * 자세한 참여 가이드 추가 * 윤리 강령 개요 * 커뮤니티: 크리에이티브 커먼즈 커뮤니티 채널과 참여자 참여 방법에 대한 정보를 제공합니다.