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