WordPressの貢献者はGutenberg開発者ドキュメントを改善するためのスポンサーを求めています
公開: 2020-07-03WordPress開発者のMilanaCapとJonathanBossengerは、Gutenberg開発者向けドキュメントを改善するための募金活動を開始しています。 昨日、企業がWordPressの作業にフルタイムの寄稿者を雇うと、ドキュメントが見落とされがちであるとキャップがツイートしたときに、会話が始まりました。
「あなたのコミュニティがあなたのソフトウェアを学ぶことができないとき、あなたには貢献者がいません」とキャップは言いました。 「ドキュメントとチュートリアルは、人々が理解しているよりも、オープンソースソフトウェアプロジェクトにとってはるかに重要です。」
キャップが初めてグーテンベルクの文書を求め始めたのは、2017年にパリで開催されたコミュニティサミットでした。それ以来、彼女はコミュニティの注意をそれに向けようとしています。
「開発者向けのブロックエディタのドキュメントには多くの穴がありますが、最も明白なものは開始方法です」とキャップ氏は述べています。 「開発者向けのドキュメントの冒頭には、開始について何も書かれていません。 「それはあなたがブロックで何ができるかだけを言いますが、_方法_は言いません。 ジュニア開発者、PHPのみの開発者、およびそのドキュメントが意味する人は誰でも、ブロックのコードがどのように見えるか、どこに配置するか、どのように含めるかなど、カスタムコンポーネントを使用してカスタムブロックを構築する方法を知りません。設定。"
ブロックエディタを文書化する際の課題の一部は、それが活発に開発されていることです。 拡張と改良は常にGutenbergプラグインにプッシュされており、コアで現在利用できるものと利用できないものを追跡することは必ずしも簡単ではありません。 WordPressはブロックディレクトリ検索を間もなく導入しているので、ブロック作成ドキュメントを形式化する良い機会です。
「コード例は、ドキュメント全体で驚くほど欠落しています」とキャップ氏は述べています。 「最も基本的な例は存在しますが、実際に使用可能なものを構築する方法が欠けています。 したがって、この最初のページではチュートリアルに送られますが、そのチュートリアルは、これまでブロックを作成したことがない人向けには最適化されていません。 それに続いて、私はブロックを構築する必要があり、失敗するでしょう。」
Marcus Kazmierczakとドキュメント寄稿者のチームは、公式のブロックエディタハンドブックでチュートリアルを再構築しようとしています。 現在の開発者向けドキュメントのギャップに対処することに焦点を当てたGitHubの問題は、開発をブロックするのが初めての人のためにドキュメントを書き直すための最良の方法について活発な議論が行われています。
「これは非常に良いスタートですが、やるべきことはまだたくさんあります」とキャップは語った。 「完全なドキュメントは、ReactとGutenbergを知っていて理解しているが、「知識に呪われている」人々によって書かれています。 彼らは、他の人がどれだけ知らないのか、そしてどのような詳細なドキュメントを書くべきかを理解するために費やす時間があまりありません。 正直なところ、彼らはそれに時間を費やすべきではないと思います。 私たちにはドキュメンテーションチームがあり、積極的に参加しますが、何らかの橋渡しが必要です。」
グーテンベルクの開発者向けドキュメントの問題：初心者には不向きです
「ブロックエディタのドキュメントで見られる「問題」は、他のWordPressドキュメントとは異なり、経験豊富なJavaScript開発者向けに書かれており、初心者を対象としていないことです」とBossenger氏は述べています。 「また、これは現在のドキュメントをまとめた人々を狙ったものではありません。彼らがこれまでに行ったすべての作業に感謝します。レビューと改良が非常に必要です。 」
Bossenger氏によると、過去のWordPressでは、PHPの知識が限られている人なら誰でも、アクションフックとフィルターフックを使用してプラグインやテーマをすばやく簡単に作成できました。 コードを見て、それが何をすべきかを理解するのは簡単でした。
「現代のJavaScript、特にReactは、まったく異なる魚のやかんです」とBossenger氏は述べています。 「新しい用語や実践を含め、Reactがどのように機能するかについてのより深いレベルの知識が必要です。 最近のJavaScriptも非常に混乱する可能性があります。特に、矢印関数などを初めて表示する場合や、ifステートメントの冗長性が低い場合はなおさらです。
「WordPressでJavaScriptを使用するのに最も近いのがjQueryを使用している場合でも、ReactベースのGutenberg開発に切り替えるには、ある程度の学習が必要です。」
Bossengerは、エディター用に何かを作成する前に2つのコースを受講した後、1つはReactで、もう1つはGutenbergで、現在のBlockEditorハンドブックはReactと最新のJavaScriptの経験がない開発者向けではないと述べました。 彼は、新しい概念をよりよく説明し、新参者が消費しやすいパターンに合わせるには、リストラが必要であると考えています。 彼は、章が構造に従い、教科書に似た用語を使用し、読者に新しい概念をゆっくりと紹介する例として、プラグイン開発者ハンドブックを強調しました。
「プラグインやPHPの知識がなくても、このハンドブックとGoogleを使用して、特定の要件を満たす簡単なプラグインをすばやく作成できる可能性は十分にあると思います」とBossenger氏は述べています。 「現在、ブロックエディタハンドブックはこれを助長していません。」
現在の文書についての彼の意見では、ボッセンジャーだけではありません。 DeliciousBrainsのPeterTaskerは最近、カスタムGutenbergブロックの作成に関するチュートリアルを公開しました。 過去1年間Reactをフルタイムで使用した後でも、彼は公式のブロックエディタードキュメントが「あちこちにあるようなもの」であり、解析が難しいことに気づきました。
キャップがドキュメンテーションに関するフルタイムの仕事を後援している会社の不足についてコメントした後、ボッセンジャーは、2人がグーテンベルクのドキュメンテーションを改善するための資金を調達できるかどうかを尋ねるツイートで水域をテストしました。
「BlockEditorTeam（および他のMakeチーム）と同じように、DocumentationTeamには人員が不足しています」とCap氏は述べています。 「ブロックエディタを使用した開発に関するドキュメントを最初に学習してから作成するために、少数のメンバーを捧げる余裕はありません。 これが私のツイートの主な理由です。 スポンサー付きの寄稿者はコア全体に表示されますが、ドキュメントには表示されません。どちらも同じように重要であるとあえて言います。」
CapとBossengerは、募金活動を開始する前に、既存のドキュメントを確認し、明らかな穴を特定し、ブロックエディターの開発に不慣れな人にとって未解決の質問を特定することを計画しています。
「計画を立てたら、各部品に必要な時間を予測できます」と彼女は言いました。 「このプランでは、スポンサーを探しに行きます。 それ以前にも寄付の選択肢はあると思いますが、現時点では定かではありません。」
ブロックはWordPress開発の新しいフロンティアです。 初心者向けの堅実なドキュメントとチュートリアルに投資することは、ブロックエコシステムの拡張に大きな影響を与える可能性があります。 これは、WordPressサイトをカスタマイズするときに選択できるブロックのディレクトリがより多様になるため、間接的にユーザーにもメリットがあります。
BossengerとCapは現在、募金活動を発表する前に、ドキュメントの計画に取り組んでいます。 それまでの間、ブロック作成ドキュメントの改善に貢献したい人は誰でもGitHubのディスカッションに参加できます。