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