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