National Resource for Network Biology(NRNB)プロジェクト

このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。

プロジェクトの概要

オープンソース組織:
National Resource for Network Biology(NRNB)
テクニカル ライター:
Rahul Agrawal
プロジェクト名:
Cytoscape.Js のドキュメントの改善
プロジェクトの長さ:
標準の期間(3 か月)

プロジェクトの説明

# Cytoscape.js のドキュメントを初心者向けにわかりやすくしました。

メンターから指定された仕様に基づき、プロジェクトを 2 つのカテゴリに分割し、このプロジェクトにこれらの機能を実装します。優先度が低い順に並べ替えています。

  • 主な機能(主要機能)

    - フェーズ 1

  • Markdown ファイルへの参照を含む既存の JSON 仕様を JSDoc コメントに移行する

  • 既存のドキュメントの精査と改善(説明の改善、コード スニペットの例の追加など)

    - フェーズ 2

  • 新しいトピックを取り上げたり、基本的なトピックを説得力のある方法で取り扱ったりする新しいチュートリアルを作成したり、動画を作成したりする。

    - フェーズ 3

  • 新しいデモや動画を作成して、本格的な Cytoscape ウェブアプリがどのようなものかを理解してください。

  • **ストレッチ ゴール **

  • ドキュメントの一般的な改善。