このページには、Google Season of Docs で承認されたテクニカル ライティング プロジェクトの詳細が掲載されています。
プロジェクトの概要
- オープンソース組織:
- クリエイティブ・コモンズ
- テクニカル ライター:
- JackieBinya
- プロジェクト名:
- WordPress ベーステーマの使用ガイド
- プロジェクトの長さ:
- 標準期間（3 か月）
プロジェクトの説明
GSOD-2020 の技術ライター応募の段階で、Creative Commons WordPress ベーステーマのドキュメント プロジェクトのメンタである Hugo Solar と何度かやり取りしました。
最初に連絡したとき、WordPress ベーステーマの使用ガイドを作成する目的についてサポートを求めたところ、とても親切に対応してくれて、すぐにプロジェクトに参加できました。その後のやり取りはすべて、CC WordPress ベーステーマのドキュメントの目的の精緻化に関するものでした。
プロジェクトの要件と目標を理解できたと感じた段階で、CC WordPress ベーステーマの使用ガイドの提案書の下書きを作成しました。
この提案書は、インターン申請用の Creative Commons 公式テンプレートを使用して作成されました。プロジェクトの概要、提案されたプロジェクト構造、新しい WordPress ベーステーマのドキュメントのレイアウト、ドキュメント作成フェーズに関するタイムラインと成果物に関する情報が記載されています。
その後、Hugo Solar が提案書の下書きを確認し、改善点についてフィードバックをくれました。彼はこのプロセス全体を通して、プロジェクトに関する質問にいつでも答えることができました。
いただいたフィードバックを反映し、D&I バッジの作成に関する最終的な提案書を Google ドキュメントとして以下のリンクからご確認いただけます。
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
提案の概要は以下のとおりです。
Creative Commons - WordPress ベーステーマの使用ガイド Jacqueline Binya が作成した提案書、2020 年 6 月 28 日
プロジェクトの概要 このプロジェクトの最終的な目標は、Creative Commons WordPress ベーステーマに関する、豊富で直感的で魅力的で美しいコミュニティ向けドキュメントを作成することです。
プロジェクト計画 問題 現在、クリエイティブ・コモンズの WordPress ベーステーマにはドキュメントがないため、コミュニティ内でテーマを効果的に活用するための障壁となっています。 私の目標は、テーマの完全な使用ガイドを作成し、WP Base テーマの現在のコードベースに抽象化を実装して、テーマの使用を容易にすることを目指しています。
ソリューション Gatsby などの最新のフレームワークを使用して、未来的なドキュメントを作成します。Gatsby には、新しい WordPress ベーステーマのドキュメントのブートストラップに使用できる開始条件が用意されています。スターターの例として、gatsby-gitbook-starter があります。これは、検索エンジン最適化（SEO）、Markdown、Algolia（静的サイトの検索用に統合するために使用されるツール）をサポートしています。さらに、Gatsby で生成されたサイトは、国際化とユーザー補助を統合するように簡単に最適化できます。ドキュメントを作成する際の狙いは、可能な限り直感的にわかるようにすることです。具体的には、次のことを行います。 - ドキュメントをわかりやすく記述し、あいまいさや複雑すぎる専門用語の使用を避けるように気をつける。 - ドキュメントにグラフィカルなイラストやメディアを組み込んで、学習を視覚的に助ける。- 一般的なタスク（カスタマイズなど）の実行方法を示すサンプルを使用する。
実装を予定している抽象化には、WP ベーステーマのコア機能のほとんど（フックなど）を、ユーザーが WordPress 管理パネルから利用できるようにすることが含まれます。さらに、WP ベーステーマのスターター サブテーマを別のリポジトリに作成したいと考えています。スターター サブテーマを使用すると、新規ユーザーのオンボーディングがスムーズかつ迅速に進みます。ドキュメントが完成して承認されると、オンラインで公開およびホストされます。
CC WordPress ベーステーマの使用ガイドの提案された構造 - 提案されているドキュメントは、以下のセクションに分かれています。提案された各セクションの下にあるサブリスト項目には、各セクションに含まれる実際のコンテンツの詳細が記載されています。
概要セクション - クリエイティブ・コモンズ（CC）WordPress 基本テーマの定義、意図、特長について説明します。 * 定義: CC WP ベーステーマについて簡単に説明します。* 目的: CC WP ベーステーマの目的を概説します。 * 機能: CC WP ベーステーマの機能を概説します。
スタートガイド セクション - 要件 * CC WordPress ベーステーマをインストールするための要件（例: - WordPress バージョン - PHP バージョン - Composer など） - インストール ガイド * ユーザーが zip を使用して CC WordPress テーマをインストールする方法を説明する * GitHub から WP ベーステーマをクローニングして利用を開始する方法を説明する * ユーザーがプロジェクトに依存関係をインストールする方法の概要を説明します。* ユーザーが依存関係の Queulat を構成する方法について説明します。* ユーザーがローカルの WordPress 開発環境でテーマを有効にする方法を説明します。
使用ガイド - 概要 * 子テーマという用語について説明します。 * 子テーマを使用するメリットを説明します。 * WP のベーステーマの編集には、子テーマの使用が推奨されることをユーザーに伝えます。 * 子テーマを作成するには、WP ベーステーマをインストールして有効にしなければならないことを強調します。
子テーマの使用 - スターターを使用して WP ベーステーマの子テーマを作成する方法について説明します。動画を使用して、スタータから子テーマを作成する方法を説明します。
カスタマイズ 以下のサブセクションでは、WordPress カスタマイザと WordPress 管理パネルを使用してカスタマイズする方法について説明します。また、説明をより直感的に行えるように、グラフィック イラストを取り入れます。 - サイトの説明やキャッチフレーズをカスタマイズします。 - カスタム ナビゲーション メニュー - CSS のカスタマイズ - ページの追加 - 投稿の追加 - ウィジェット - WordPress 管理パネルからウィジェットを追加、削除する - ライブプレビュー付きのカスタマイザーを使用してウィジェットを追加する
高度なカスタマイズ セクション - CSS のカスタマイズ セクション * テーマのスタイルを構成するコンポーネントについて説明します。 - CC の用語 - Bulma - Sass * プロジェクトで Sass を設定する方法について説明します。説明には次の情報を含める必要があります。 （i）プロジェクト構造内の sass ファイルの場所 （ii）sass のビルドと監視に使用できる npm スクリプト * ユーザーが子テーマの sass スタイルをカスタマイズする方法（特定の npm 依存関係のインストールなど）を説明する * コンポーネント クラス（特定のコンポーネントの class-component.php）を使用してカスタマイズする方法を説明する
- フック セクション
概要
- フックという用語について説明する
- ユーザーがフックを活用する必要がある理由を説明します。
- 使用可能なフックの種類について概説します。
アクションの使用
- WP Base テーマで利用可能なアクションとその配置を一覧表示する
- これらのアクションを実装する方法について説明します。
*フィルタの使用 - テーマで使用可能なフィルタをリストアップし、その実装方法を説明します
テーマの更新セクション - ユーザーがテーマを更新する方法について説明します。
ライセンス セクション * プロジェクトのライセンスと、個人プロジェクトで CC WP ベーステーマを使用する場合の意味について説明します。
コントリビューション セクション * 詳細なコントリビューション ガイドを追加する * 行動規範を概説 * コミュニティ: クリエイティブ・コモンズのコミュニティ チャンネルに関する情報を提供し、コントリビューターの参加方法などを提供する。