このページには、Google Season of Docs で承認されたテクニカル ライティング プロジェクトの詳細が掲載されています。
プロジェクトの概要
- オープンソースの組織:
- 食品成分情報を開く
- テクニカル ライター:
- FutureOfDocs
- プロジェクト名:
- Open Food Facts API のドキュメントを作成
- プロジェクトの長さ:
- 長期実行（5 か月）
プロジェクトの説明
「ドキュメント シーズン」について初めて知ったのは、数か月前に受講した REST API ドキュメントに関するコースのインストラクターから届いたメールでした。アイデアはとても気に入りましたが、本当に気に入った場合にのみプロジェクトに応募することにしました。副業は、通常の仕事以外で行うもので、楽しくて有意義なものであるべきです。
Open Food Facts の説明を読んだとき、このプロジェクトを見つけたことがわかりました。私は運動や食事で体と健康を大切にするのが大好きです。栄養は幸せな生活の鍵の一つだと私は考えています。誰もがより良い選択をできるべきですが、そのためには、使用する食品や化粧品について十分な情報を得る必要があります。Open Food Facts では、この情報を利用できます。この素晴らしいイニシアチブに貢献したいと思っています。
過去 3 年間は、プロセスとリリースの自動化を専門とするソフトウェア開発会社でテクニカル ライターとして働いていました。たとえば、Swagger を使用して REST API を実装し、デベロッパーが API リクエストを介して Google のアプリケーションと通信できるようにしています。私は、リクエストとレスポンスの説明をより適切に記述できるよう開発チームをサポートし、お客様に必要な情報を明確かつ簡潔に提供できるよう、一緒に特定しました。
現在の Open Food Facts API サイトを確認いたしましたが、ドキュメントを再構成して、よりユーザー フレンドリーに（[General]、[READ]、[WRITE] の各ページ）改善できると思います。さらに、開発チームと協力して、コードから API ドキュメントを自動生成する方法を確立したいと考えています（これには時間がかかるため、長期にわたるコラボレーションを提案しています）。
見た目が重要であることは誰もが知っています。そのため、REST API の CSS とロゴを調整して、Swagger UI をユーザー ドキュメントに合わせることもできます。
このプロジェクトで一緒に取り組めることを楽しみにしています。