このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- ジュリア語
- テクニカル ライター:
- Shuo Liu
- プロジェクト名:
- LightGraphs Docs 2.0 とユーザー フレンドリーな JuliaGraphs チュートリアル
- プロジェクトの長さ:
- 長期実行（5 か月）
プロジェクトの説明
この長期にわたるプロジェクトで、JuliaGraphs のモジュールのウェブサイトやドキュメントを改善します。具体的には、私の作品には以下のようなコンテンツが含まれますが、これに限定されるものではありません。
LightGraphs のドキュメント 2.0 - 10 週間
- 概要: LightGraphs.jl は、Julia 用に最適化された軽量グラフ パッケージであり、JuliaGraphs エコシステムのコアとして機能します。まもなくリリースされる LightGraphs のバージョン 2.0 では、LightGraphs API が根本的に変更されます。ドキュメントに LightGraphs の最新の機能が反映されるようにします。
- 成果物: 既存の API ドキュメントを監査して、変更が不要なドキュメントを特定し、2.0 リリースで行われた変更を分析して、例とともに適切にドキュメント化します。このプロセスでは、2.0 リリースの主な変更点に関する投稿を作成します。新規ユーザーが LightGraphs をより深く理解できるように、Julia でグラフを使用する世界に初めて足を踏み入れるユーザー向けの初心者ガイドを作成します。
- 注: このプロジェクトでは、ドキュメント ジェネレータとして Documenter.jl を使用して LightGraphs のドキュメントを作成します。Coloring.jl などのモジュールの API リファレンスに加えて、greedy_color.jl などのサブモジュールの API リファレンスも必要です。LightGraphs のドキュメントを更新するために、それらを追加する方法を検討します。また、グラフ理論は数学のかなり専門的な分野であり、数学的なバックグラウンドがない人にはわかりにくいものです。私は約 2 年間学術研究に携わり、個人のウェブサイトに多くのブログ投稿を書いてきました。そのため、初心者向けガイドを作成する際に、さまざまなアルゴリズムの概要を説明し、さまざまな状況でどのアルゴリズムを使用するかについてヒントを提供できます。
JuliaGraphs のチュートリアル - 10 週間
- 概要: JuliaGraphs パッケージのドキュメントの多くはデベロッパー向けです。簡単な例を追加し、各機能の使用方法を説明して、ユーザーがより簡単に利用できるようにします。
- 成果物: 既存の LightGraphs チュートリアルを監査し、追加が必要な資料を確認して、各機能の使用方法と目的を説明します。次に、JuliaGraphsTutorials の形式に沿って、LightGraphs エコシステムの初心者ガイドを含む JuliaGraphs チュートリアルを拡張します。
- 注: JuliaGraphsTutorials の内容は現在十分ではありません。上記の成果物はほとんどが LightGraphs パッケージ用です。時間があれば、JuliaGraphs の他のモジュール（GraphPlot.jl、MetaGraphs.jl、SimpleWeightedGraphs.jl など）のチュートリアルも追加する予定です。
JuliaGraphs の中央ウェブサイト - 4 週間
- 概要: JuliaGraphs の中央ウェブサイトには、エコシステムのパッケージの概要が掲載されています。ただし、まだ大部分は説明であり、Julia でグラフを使い始める人々にとって最初のリソースになるよう、さらに改善できます。さまざまな JuliaGraphs パッケージの機能を視覚的にハイライトする直感的な方法を見つけます。
- 成果物: JuliaGraphs パッケージの機能を紹介するユースケースと例を提示し、監査を実施して、それらが引き続き関連性があり、サポートされていることを確認します。さまざまな分野（医療、教育など）におけるさまざまなパッケージのさまざまな用途に焦点を当てたセクションを作成します。時間があれば、グラフで使用されているアルゴリズムの視覚的な説明を調査します。
- 注: 多くの JuliaGraphs パッケージがさまざまなドメインで広く使用されています。DiGraph for NetworkViz などのプロット拡張機能に加えて、生物学における BioStructures の MetaGraph、都市計画における TrafficAssighnment の DijkstraState、教育における TreeView の DiGraph など、特定の分野のアプリケーションも含める予定です。