このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- Django
- テクニカル ライター:
- 不気味
- プロジェクト名:
- 投稿ガイドを書き直して、よりユーザー フレンドリーで見やすいものに
- プロジェクトの期間:
- 標準の期間（3 か月）
プロジェクトの説明
概要
他のドキュメントと同様、Django のコントリビューション ガイドの目標は、このケースでユーザーやオープンソース コントリビューターに、Django の改善と持続可能性に貢献できる方法について説明することです。
コミュニティと Django 自体に大きな影響を与えるドキュメントを作成することは常に必要です。
Django が今年の Google Summer of Docs で目指しているのは、投稿ガイドが負担なく利用しやすく、寄稿者を歓迎しやすいものにすることです。これは貢献者を奨励するために不可欠な目標です。この優れたフレームワークに貢献することを始めるにあたり、私自身もその目標に属しています。
現在のステータス
ここに記載されているドキュメントの現在の段階は、あまりにもガイドとしてあまり難しくなく、構造化が十分でなく、Django への貢献についての理解が十分でなく、新しいコントリビューターを歓迎していません。
プロジェクトの目標
フォーラムでメンターのカールトン ギブソンとドキュメントに関する提案について話し合いましたが、現在のドキュメントでの圧倒的な問題に対応できることを彼は認めてくれました。私がドキュメントの再構築を計画しています ドキュメントを再構成する 推奨事項と禁止事項のセクションを追加する リクエストや機能などの簡単なセクション用の単一ページを作成する 単語を簡潔にしてわかりやすいドキュメントを作成する 単語用の用語集 より親しみやすいドキュメントを作成する より親しみやすい文書を作成する 初心者向けのガイドと文書作成用の新しいガイドスタイルと高度なドキュメントを作成する
現在のドキュメントは、すでに上級コントリビューターを対象としており、オープンソースと Django への新規および初心者のコントリビューターが参加することはできません。初心者向けの追加コンテンツは次のとおりです。 さまざまなコントリビューター（テクニカル ライター、デザイナー、デベロッパー）向けにガイドするセクションです。最初のタイマーに関する問題と解決可能な簡単な問題を文書化したページです。 現在のドキュメントからいくつかのセクションを作成し、初心者向けセクションに書き直して追加します。 詳細セクションで使用する重要ポイントや用語を説明するセクション。
タイムライン
上記のプロジェクト目標をどのように達成したいかについて、Google が提供するカレンダーで詳しくご説明いたします。
コミュニティ・ボンディング・ウィーク（8 月 17 日～ 9 月 13 日） コントリビューター追加ガイドと追加のコントリビューター・セクションをまとめる 7 週目 - 新しいコントリビューター・コントリビューター・セクションをまとめる コミュニティーとの関わりを深める ドキュメントへの貢献を続ける コントリビューターからさらなる提案を受ける 現在のドキュメントと使用対象ツールについてさらに学習する 第 1 週～第 4 週 ドキュメントの初級セクションを作成する 第 4 週目と禁止事項セクションを作成する 第 4 週目と禁止事項のまとめ
ツール
Sphinx - 現行のドキュメント用の現行ツール。ドキュメントを読む
このプロジェクトの目的
私は、世界中の人々を包括する適切な文書と記事を作成することを心から信じています。それ以外に、私は Django とオープンソース全体に愛を持っています。私は初心者として Django に貢献したいと思っていました。私のお気に入りのツールに貢献すると同時に、コードベースに慣れ、開発者（およびテクニカル ライター）としてより貢献できる方法にもなると思います。私の見解に合致し、キャリア全体にわたって素晴らしいツールになっている組織と仕事ができ、嬉しくて美しいと思います。
私がこのプロジェクトの適任者である理由
以下の記事を参考に、私は Django に貢献していると思います。 初心者の方が Django のコンセプトを理解しやすくなるよう、記事を書いて Django に貢献してきました。私はデベロッパーであり、また Django への貢献に意欲的であるため、他のデベロッパーの必要性と、彼らのためにそれをうまく文書化する方法を理解しています。私はチーム プレーヤーで、メンターのカールトン ギブソンの指導のもとで、しっかりと仕事をしています。