このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- Julia 言語
- テクニカル ライター:
- sophb
- プロジェクト名:
- FluxML ウェブサイトの再構築
- プロジェクトの期間:
- 標準の期間（3 か月）
プロジェクトの説明
この提案は、Flux のドキュメント ウェブサイトを改善して、そこに含まれる情報が構造化され、新規参入者や専門家にとって魅力的なものとなるようにすることを目的としています。具体的には、既存のドキュメントを新しいセクションに整理し、初心者向けに Flux 60-mine-blitz チュートリアルを拡張した新しいスタートガイドを作成することを目標としています。
このプロジェクトは、次のフェーズで構成されています。
現在のドキュメント ウェブサイトを分析する: 既存の情報を監査し、新しいチュートリアルを作成するためのスタイルガイドを定義します。
情報と開始チュートリアルの新しい構造を定義する: メンターと協力して、新しいセクションを決定し、ドキュメント ウェブサイトの再編成を行います。また、Flux 60 鉱山大爆発のチュートリアルを出発点として使用し、入門チュートリアルの目次を定義し、それを基に構築を行います。
情報を再構築する: 前のステップでメンターと協力して決めたプランに合わせて、ウェブサイトを更新します。
スタートガイド チュートリアルを作成する: 最初の下書きを書いて確認します。メンターからフィードバックを得る。メンターと私が、このドキュメントの最終版が完成したら、ドキュメントのウェブサイトで公開します。
（オプション）README 形式の既存のドキュメントを HTML に変換する: 4 つの主要なフェーズを完了したあとに時間がある場合は、README である既存のチュートリアルを変換して、ウェブサイトからアクセスしやすくします。
プロジェクトの目標を達成するため、Flux コミュニティと緊密に連携して既存のドキュメントを理解し、最適なアプローチを判断します。私自身は Julia を初めて利用するのですが、新しいチュートリアルを始めるにあたって、どのレベルに関する情報が適切かを判断するのに非常に役立つと思います。
自分の仕事を通じて、Flux コミュニティが新しい使い方を実践しやすくなるよう注力します。また、経験豊富なユーザーが新しいユースケースを発見し、Flux の詳細を確認できるよう支援することにも焦点を当てます。