このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- クリエイティブ・コモンズ
- テクニカル ライター:
- JackieBinya
- プロジェクト名:
- WordPress のベーステーマの使用ガイド
- プロジェクトの期間:
- 標準の期間（3 か月）
プロジェクトの説明
GSOD-2020 のテクニカル ライターの応募段階で、クリエイティブ・コモンズの WordPress ベーステーマのドキュメント プロジェクトのメンターである Hugo Solar と何度かやり取りしました。
最初の連絡で、WordPress の基本テーマの使用ガイドを作成する目的を理解してほしいと相談しました。とても親切に教えてくれ、すぐにプロジェクトに関わってくれました。その後のやり取りは、いずれも CC WordPress 基本テーマ ドキュメントの目的を絞り込むものでした。
ステージに到達すると、プロジェクトの要件と目標を理解していると感じて、CC WordPress 基本テーマ使用ガイドの提案の下書きを作成しました。
この提案は、クリエイティブ・コモンズのインターン応募用の公式テンプレートを使用して作成されました。プロジェクトの概要、提案されているプロジェクト構造、新しい WordPress 基本テーマドキュメントのレイアウトだけでなく、ドキュメント作成フェーズのタイムラインと成果物についての情報も記載されています。
Hugo Solar は提案書の下書きを確認し、改善すべきフィードバックを提供してくれました。このプロセスの間、彼はプロジェクトに関する質問に常に答えてくれました。
提供されたフィードバックを実装し、建物の D&I バッジに関するドキュメントの最終案を、以下のリンクから Google ドキュメントとして入手できます。
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
または、私の提案の概要を以下で報告することもできます。
クリエイティブ・コモンズ - WordPress ベーステーマ使用ガイド 提案書作成: Jacqueline Binya、2020 年 6 月 28 日
プロジェクトの概要 このプロジェクトの最終的な目標は、クリエイティブ・コモンズの WordPress ベーステーマについて、リッチで直感的に操作でき、魅力的で、美しく表示されるコミュニティ向けドキュメントを作成することです。
プロジェクト計画 問題 現在、クリエイティブ・コモンズ WordPress のベーステーマにはドキュメントがありません。これは、コミュニティ内でテーマを効果的に使用するうえでの障壁となっています。 私の目標は、テーマの詳細な使用ガイドを作成することです。また、WP Base テーマの現在のコードベースに抽象化を実装して、テーマを使いやすくすることです。
ソリューション Gatsby のような最新のフレームワークを使用して、未来的なドキュメントを作成できます。Gatsby には、新しい WordPress ベーステーマ ドキュメントのブートストラップに使用できるスターターがあります。スターターの例としては、検索エンジン最適化（SEO）、マークダウン、Algolia（静的サイトでの検索の統合に使用するツール）をサポートする、すぐに使える gatsby-gitbook-starter があります。さらに、Gatsby が生成したサイトであれば、多言語対応とアクセシビリティを統合するために簡単に最適化できます。ドキュメントを作成する目的は、可能な限り直感的にすることです。 - ドキュメントを理解しやすい方法で記述し、あいまいさや過度に複雑な専門用語の使用を避けるために注意を払う。- ドキュメントにグラフィカルなイラストやメディアを組み込み、学習の視覚要素として使用できる。 - 一般的なタスク（カスタマイズなど）の実行方法を示す例を使用
実装したい抽象化には、フックなどの WP ベーステーマのコア機能のほとんどを、ユーザーが WordPress 管理パネルからユーザーが利用できるようにすることが含まれます。これに加えて、WP ベーステーマ用のスターターの子テーマを別のリポジトリに作成することをおすすめします。開始条件の子テーマを用意することで、新規ユーザーのオンボーディング エクスペリエンスがよりスムーズかつ迅速に提供されるようになります。 ドキュメントが完成して承認されると、オンラインで公開およびホストされます。
CC WordPress 基本テーマ使用ガイドの構造案 - 提案するドキュメントは、以下のセクションに分かれています。提案された各セクションのサブリストの項目には、それぞれのセクションに表示される実際のコンテンツの詳細が表示されます。
概要セクション - クリエイティブ・コモンズ（CC）WordPress ベーステーマの定義、意図、機能について概説します。 * 定義: CC WP ベーステーマについて簡単に説明します。 * 意図: CC WP ベーステーマの目的/ 意図を概説します * 機能: CC WP ベーステーマの機能を概説します
「Getting Started」セクション - 要件 * CC WordPress ベーステーマをインストールするための要件の概要（ - WordPress バージョン - PHP バージョン - Composer など） - インストール ガイド * ユーザーが zip を使用して CC WordPress テーマをインストールする方法を説明する * ユーザーが GitHub から WP ベーステーマのクローンを作成する方法について説明する * ユーザーがプロジェクトに依存関係をインストールする方法の概要を説明する。 * ユーザーが依存関係の Queulat を構成する方法を説明する。 * ユーザーがローカルの WordPress 開発環境でテーマを有効にする方法を説明する。
使用ガイド - 概要 * 子テーマという用語を説明する * 子テーマを使用する利点を説明する。 * WP Base テーマの編集には子テーマを使用することを推奨しています。 * ユーザーが子テーマを作成するには、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 基本テーマを使用したいユーザーにどう影響するかを説明する。
貢献するセクション * 詳細な貢献ガイドを追加する * 行動規範の概要を説明する * コミュニティ: クリエイティブ・コモンズのコミュニティ チャネルに関する情報や、協力者が参加する方法などを提供します。