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