このページには、Google シーズンの Google ドキュメントで承認されたテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- National Resource for Network Biology（NRNB）
- テクニカル ライター:
- Rahul Agrawal 氏
- プロジェクト名:
- Cytoscape.Js のドキュメントの改善
- プロジェクトの期間:
- 標準の長さ（3 か月）
プロジェクトの説明
# 初心者でも Cytoscape.js ドキュメントを利用しやすくする
メンターから指摘された仕様に従ってプロジェクトを 2 つのカテゴリに分けました。このプロジェクトにこれらの機能を導入します。優先度の高い順に掲載しています。
主な機能（主な機能）
- フェーズ 1
Markdown ファイルへの参照を含む既存の JSON 仕様を JSDoc コメントに移行する
より適切な説明を作成したり、サンプル コード スニペットを追加したりするなど、既存のドキュメントの改良と改善
- フェーズ 2
新しいチュートリアルや動画を作成して、新しいトピックを取り上げたり、基本的なトピックをより説得力のある方法で取り上げたりします。
- フェーズ 3
本格的な Cytoscape ウェブアプリがどのようなものかを体感してもらうための新しいデモの記述や動画の作成。
**ストレッチゴール **
ドキュメントの全般的な改善。