WordPress 기고자들은 Gutenberg 개발자 문서 개선을 위해 후원을 구합니다

WordPress 개발자 Milana Cap과 Jonathan Bossenger는 Gutenberg 개발자 문서 개선을 위한 모금 행사를 시작합니다. 이 대화는 어제 Cap이 회사에서 WordPress 작업을 위해 전임 기고자를 고용할 때 문서가 종종 간과되는 방법에 대해 트윗하면서 시작되었습니다.

"커뮤니티가 소프트웨어를 배울 수 없으면 기여자가 없는 것입니다."라고 Cap이 말했습니다. "오픈 소스 소프트웨어 프로젝트에서 문서와 튜토리얼은 사람들이 생각하는 것보다 훨씬 더 중요합니다."

Cap이 처음으로 구텐베르크 문서를 요청하기 시작한 것은 2017년 파리에서 열린 Community Summit에서였습니다. 그녀는 그 이후로 커뮤니티의 관심을 이 문서로 이끌기 위해 노력해 왔습니다.

"개발자를 위한 블록 편집기 문서에는 많은 허점이 있지만 가장 분명한 것은 시작하는 방법입니다."라고 Cap이 말했습니다. “개발자를 위한 문서화의 시작은 시작에 대해 아무 말도 하지 않습니다. “블록으로 무엇을 할 수 있는지만 설명하지만 _어떻게_는 설명하지 않습니다. 주니어 개발자, PHP 전용 개발자 및 문서가 의미하는 모든 사람은 사용자 정의 구성 요소로 사용자 정의 블록을 빌드하는 방법은 고사하고 블록의 코드가 어떻게 보이는지, 어디에 넣을지, 포함하는 방법 등을 모릅니다. 설정."

블록 편집기 문서화의 과제 중 하나는 블록 편집기가 현재 개발 중이라는 것입니다. 개선 사항 및 개선 사항은 지속적으로 Gutenberg 플러그인으로 푸시되며 현재 코어에서 사용할 수 있는 항목과 없는 항목을 추적하는 것이 항상 쉬운 것은 아닙니다. 워드프레스가 블록 디렉토리 검색을 임박하게 도입함에 따라 블록 생성 문서를 공식화하기에 좋은 시기입니다.

Cap은 "코드 예제가 문서 전체에 놀라울 정도로 누락되어 있습니다. “가장 기본적인 예는 존재하지만 실제로 사용할 수 있는 것을 구축하는 방법이 빠져 있습니다. 따라서 이 첫 번째 페이지에서 우리는 튜토리얼로 보내지지만 그 튜토리얼은 이전에 블록을 만든 적이 없는 사람들을 위해 최적화되어 있지 않습니다. 그 뒤를 따라 나는 블록을 만들지 못했고 앞으로도 실패할 것입니다.”

Marcus Kazmierczak과 문서 기고자 팀은 공식 블록 편집기 핸드북에서 튜토리얼을 다시 작성하려고 합니다. 현재 개발자 문서의 격차를 해결하는 데 중점을 둔 GitHub 문제는 블록 개발을 처음 접하는 사람들을 위해 문서를 다시 작성하는 가장 좋은 방법에 대한 활발한 토론의 본거지입니다.

“이것은 아주 좋은 시작이지만 아직 해야 할 일이 많이 있습니다.”라고 Cap이 말했습니다. “완전한 문서는 React와 Gutenberg를 알고 이해하지만 '지식의 저주'를 받은 사람들에 의해 작성되었습니다. 그들은 다른 사람들이 얼마나 모르고 어떤 세부 문서를 작성해야 하는지 이해하는 데 많은 시간을 할애하지 않습니다. 솔직히 말해서, 나는 그들이 그것에 시간을 할애해야 한다고 생각하지 않습니다. 우리에게는 문서화 팀이 있고 기꺼이 뛰어들지만 일종의 다리 역할이 필요합니다.”

구텐베르크 개발자 문서의 문제점: 초보자에게 친숙하지 않습니다.

Bossenger는 "블록 편집기 문서에서 볼 수 있는 '문제'는 다른 WordPress 문서와 달리 숙련된 JavaScript 개발자를 위해 작성되었으며 초보자를 대상으로 하지 않는다는 것입니다."라고 말했습니다. "또한 이것은 현재 문서를 정리한 사람들을 겨냥한 것이 아니며 지금까지 수행한 모든 작업에 감사드립니다. 검토와 약간의 개선이 심각하게 필요합니다. "

Bossenger는 과거 WordPress를 통해 제한된 PHP 지식을 가진 사람이 작업 및 필터 후크를 사용하여 플러그인이나 테마를 빠르게 구축할 수 있었다고 말했습니다. 코드를 보고 무엇을 해야 하는지 이해하기 쉬웠습니다.

Bossenger는 "현대 JavaScript, 특히 React는 매우 다른 물고기 주전자입니다. “새로운 용어와 관행을 포함하여 React가 어떻게 작동하는지에 대한 더 깊은 수준의 지식이 필요합니다. 최신 JavaScript는 특히 화살표 기능이나 덜 장황한 if 문과 같은 것을 처음 보는 경우 매우 혼란스러울 수 있습니다.

"WordPress에서 JavaScript로 작업하는 데 가장 가까이 다가온 것이 jQuery를 사용한 것이라면 React 기반 Gutenberg 개발로 전환하려면 여전히 약간의 학습이 필요합니다."

에디터용으로 하나는 React와 하나는 Gutenberg에서 빌드하기 전에 두 개의 코스를 수강한 Bossenger는 현재 Block Editor 핸드북은 React와 최신 JavaScript에 대한 경험이 없는 개발자를 위해 작성되지 않았다고 말했습니다. 그는 새로운 개념을 더 잘 설명하고 신규 이민자가 더 쉽게 소비할 수 있는 패턴에 맞추기 위해 구조 조정이 필요하다고 생각합니다. 그는 플러그인 개발자 핸드북을 책과 같은 구조를 따르고 용어를 사용하여 독자에게 천천히 새로운 개념을 소개하는 예로 강조했습니다.

Bossenger는 "플러그인이나 PHP 지식이 없는 사람도 이 핸드북과 Google로 무장하여 특정 요구사항을 매우 빠르게 충족하는 간단한 플러그인을 구축할 수 있을 것이라고 주장합니다."라고 말했습니다. "현재 블록 편집기 핸드북은 이에 도움이 되지 않습니다."

현재 문서에 대한 그의 견해는 Bossenger만이 아닙니다. 딜리셔스 브레인의 Peter Tasker는 최근 맞춤형 Gutenberg 블록 생성에 대한 튜토리얼을 게시했습니다. 지난 1년 동안 React에서 풀타임으로 일한 후에도 그는 공식 블록 편집기 문서가 "도처에 있는 종류"이고 구문 분석하기 어렵다는 것을 알게 되었습니다.

Cap이 문서 작업을 후원하는 회사의 부족에 대해 언급한 후 Bossenger는 두 회사가 Gutenberg 문서 개선을 위한 기금을 모을 수 있는지 묻는 트윗으로 물을 테스트했습니다.

"블록 편집기 팀(및 다른 Make 팀)과 마찬가지로 문서 팀은 인력이 부족합니다."라고 Cap이 말했습니다. “우리는 블록 편집기를 사용한 개발에 대한 문서를 먼저 배우고 작성하는 데 몇 명의 회원을 할애할 여유가 없습니다. 이것이 제 트윗의 주된 이유입니다. 당신은 핵심 전체에 걸쳐 후원 기여자들을 볼 수 있지만 문서에서는 그렇지 않으며 둘 다 똑같이 중요하다고 감히 말할 수 있습니다.”

기금 마련 행사를 시작하기 전에 Cap과 Bossenger는 기존 문서를 살펴보고 명백한 허점을 찾아내고 블록 편집기 개발을 처음 접하는 사람들을 위해 풀리지 않은 질문을 식별할 계획입니다.

“일단 계획이 수립되면 각 부품에 필요한 시간을 예측할 수 있습니다.”라고 그녀는 말했습니다. “이번 계획으로 우리는 후원자를 물색할 것입니다. 그 전에도 기부할 수 있는 방법이 있을 거라 생각하지만, 현시점에서 확실한 것은 없다”고 말했다.

블록은 WordPress 개발의 새로운 영역입니다. 초보자를 위한 탄탄한 문서와 튜토리얼에 투자하는 것은 블록 생태계 확장에 큰 영향을 미칠 수 있습니다. 이것은 또한 사용자가 WordPress 사이트를 사용자 정의할 때 선택할 수 있는 더 다양한 블록 디렉토리를 갖게 되므로 간접적으로 도움이 됩니다.

Bossenger와 Cap은 현재 모금 행사를 발표하기 전에 문서에 대한 계획을 세우고 있습니다. 그동안 블록 생성 문서 개선에 기여하고 싶은 사람은 누구나 GitHub 토론에 참여할 수 있습니다.