このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- OpenMRS.org
- テクニカル ライター:
- Ayeshmantha
- プロジェクト名:
- REST API 用のユーザー フレンドリーな GithHub ドキュメントの作成
- プロジェクトの期間:
- 標準の期間（3 か月）
プロジェクトの説明
このプロジェクトの主な目標は、エンドユーザーが試用オプションを使用して API を操作できるインタラクティブなドキュメントを作成することです。その間に、エンドポイントを使用する必要がある状況について技術者と非技術者が説明する、より説明的で自己説明的な説明を作成します。
現在の Swagger 環境は素晴らしいものですが、技術者でなく、技術者にとっても、適切なドキュメントがないとアイデアを直接把握することは困難です。主なアイデアは、この素晴らしい環境とドキュメントを 1 か所にわかりやすく表現してまとめることです。JS、HTML、および CSS が活用されています。