このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- ジュリア語
- テクニカル ライター:
- sophb
- プロジェクト名:
- FluxML ウェブサイトの刷新
- プロジェクト期間:
- 標準の期間（3 か月）
プロジェクトの説明
この提案は、Flux のドキュメント ウェブサイトを改善し、その情報に構造を与え、新規ユーザーとエキスパートにとって魅力的なものにすることです。具体的には、既存のドキュメントを新しいセクションに再編成し、Flux 60-mine-blitz チュートリアルを拡張した、新規ユーザー向けの新しいスタートガイド チュートリアルを作成することを目標としています。
このプロジェクトは次のフェーズで構成されています。
現在のドキュメント ウェブサイトを分析する: 既存の情報を確認し、新しいチュートリアルを作成する際のスタイルガイド（情報用）を定義します。
情報とスタートガイドのチュートリアルの新しい構造を定義する: メンターと協力して、ドキュメント ウェブサイトの新しいセクションと再編成を決定します。また、Flux 60-mine-blitz チュートリアルを出発点として使用し、その上に構築して、スタートガイド チュートリアルの目次を定義します。
情報を再構成する: 前の手順でメンターと協力して定義した計画に基づいて、ウェブサイトを更新します。
スタートガイドを作成する: 最初の下書きを作成してレビューします。メンターからフィードバックを得る。メンターと私が、このドキュメントの完成版が完成したら、ドキュメント ウェブサイトで公開します。
（省略可）README 形式の既存のドキュメントを HTML に変換する: 4 つの主要なフェーズを完了した後に時間があれば、README 形式の既存のチュートリアルを変換して、ウェブサイトから簡単にアクセスできるようにします。
このプロジェクトの目標を達成するため、Flux コミュニティと緊密に連携して、既存のドキュメントを理解し、最適なアプローチを決定します。私は Julia を初めて使用するので、この新しいチュートリアルで情報のレベルを正しく判断するうえで大いに役立つと思います。
今後は、Flux コミュニティで新しいユーザーをオンボーディングする際に役立つよう、取り組んでまいります。また、経験豊富なユーザーが新しいユースケースを見つけ、Flux の詳細を把握できるようにすることにも重点を置きます。