このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- Django
- テクニカル ライター:
- Gabbyprecious
- プロジェクト名:
- 投稿ガイドを書き直し、ユーザー フレンドリーでナビゲーションを容易に
- プロジェクト期間:
- 標準期間（3 か月）
プロジェクトの説明
ABSTRACT
他のドキュメントと同様に、Django の貢献ガイドの目的は、ユーザー（この場合はオープンソースのコントリビューター）が Django の改善と持続可能性に貢献する方法と場所を案内することです。
ドキュメントの作成は常に必要です。特に、コミュニティや Django 自体に大きな影響を与えるものは必要です。
今年の Google Summer of Docs における Django の目標は、コントリビューション ガイドをわかりやすく、アクセスしやすく、コントリビューターにとって魅力的なものにすることです。これは、この素晴らしいフレームワークに貢献し始めるコントリビューター（私自身もその一人です）を奨励するうえで不可欠な目標です。
現在の状態
現在のドキュメント（こちら）は、内容が膨大で構造が整っていないため、ガイドとしてはあまり役に立ちません。Django への貢献を理解しづらく、新しいコントリビューターにとっても歓迎されません。
プロジェクトの目標
ドキュメントに関する提案をフォーラムでメンターの Carlton Gibson と話し合いました。彼は、現在のドキュメントの圧倒的な問題の解決に役立つと認めています。ドキュメントの再構成で達成する予定の目標は次のとおりです。ドキュメントの再構成 セクションごとの「すべきこと」と「すべきでないこと」の追加 機能のリクエストや作成など、単純なセクションの単一ページの作成 簡潔で要点を絞ったドキュメントの作成 用語の用語集 新しいガイドに沿って作成された内部インデックス より親しみやすいドキュメントの作成 コンテンツを 2 つのメイン パート（初心者と上級の作成者向けのセクション）に分割 新しい技術ライター/作成者向けのガイドとスタイルを構築し、ドキュメントを最新の状態に保ち、標準に準拠させる。
現在のドキュメントは上級の貢献者を対象としており、オープンソースと Django の両方で、新規および初心者の貢献者にチャンスを与えていません。初心者向けの追加コンテンツは次のとおりです。 さまざまな貢献者（技術ライター、デザイナー、デベロッパー）をガイドするセクション 初心者向けの問題と簡単に解決できる問題を記述したページ。現在のドキュメントのいくつかのセクションを書き直し、初心者向けのセクションに追加します。上級者向けのセクションで使用されている重要なポイントや用語について説明するセクション。
タイムライン
以下に、Google から提供されたカレンダーに基づき、上記のプロジェクト目標の達成に向けてどのように取り組むかを示します。
コミュニティの結束強化週間（8 月 17 日～ 9 月 13 日） コミュニティとの交流を深める ドキュメントへの継続的な貢献 コントリビューターからの提案の収集 現在のドキュメントと目的のツールの詳細な調査 1 週目～ 4 週目 レベルに基づくドキュメントの分割の開始 ドキュメントの初心者向けセクションの作成 4 週目～ 6 週 「すべきこと」と「すべきでないこと」のキュレーション セクションごとの「すべきこと」と「すべきでないこと」の記述 セクションの追加ページ 7 週目～ 9 週 現在のドキュメントを書き直し、上級コントリビューター ガイドに移動 ドキュメントの削減 10 週目～ 12 週 用語集の準備 内部インデックスを新しいドキュメントに更新 新規の技術ライター/コントリビューター向けのガイドとスタイルを作成する
ツール
Sphinx - 現在のドキュメントの現在のツール。ドキュメントを読む。
このプロジェクトの目的
私は、世界中のあらゆる人々を包含する適切な文書や記事を提供することを信条としています。それ以外にも、Django とオープンソース全体を愛しています。初心者として Django に貢献したいと思っていました。このプログラムは、お気に入りのツールに貢献しつつ、コードベースに慣れて、デベロッパー（および技術ライター）としてより多くの貢献をするための最適な方法だと思います。私の考えと一致し、私のキャリア全体にとって素晴らしいツールである組織で働くことは、楽しいものになるでしょう。
私がこのプロジェクトの適任者である理由
次の理由から、私はこの役職にふさわしいと考えています。これまで、初心者が Django のコンセプトを理解できるよう記事を書いて Django に貢献してきました。私はデベロッパーであり、Django に貢献したいと考えているので、仲間のデベロッパーのニーズや、彼らのためにドキュメントを適切に文書化する方法を理解しています。 私はチーム プレーヤーで、メンターのカールトン ギブソン氏に少し、または少しだけ頼りにされれば、うまくやっていくでしょう。