このページには、Google シーズンの Google ドキュメントで承認されたテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- 食べ物の成分を開く
- テクニカル ライター:
- FutureOfDocs
- プロジェクト名:
- Open Food Facts API を文書化する
- プロジェクトの期間:
- 長時間実行（5 か月）
プロジェクトの説明
「ドキュメントのシーズン」というのは、数か月前に REST API ドキュメントに関するコースの講師から送られたメールで初めて知りました。そのアイデアはとても気に入りましたが、本当にその内容に納得できる場合のみ応募することにしました。これは私の通常の仕事とは別の仕事でした。もしそうしたら、楽しく有意義に過ごせるに違いありません。
Open Food Facts の説明を読んで、このプロジェクトを見つけました。 運動と食事で自分の体と健康を大事にしています。栄養は幸せな生活を送るための鍵の 1 つであり、私たち全員がより良い選択をできるようにする必要があります。これは、使用する食品や化粧品について十分な情報がある場合にのみ可能であると考えています。Open Food Facts はこの情報を自由に使用して、この素晴らしい取り組みに貢献したいと考えています。
この 3 年間は、プロセスとリリースの自動化を専門とするソフトウェア開発会社でテクニカル ライターとして働いていました。特に、Swagger を使用して REST API を実装し、デベロッパーが API リクエストを介してアプリケーションと通信できるようにしています。私は、リクエスト/レスポンスについてのより適切な説明を書く開発チームを支援してきました。そして、お客様がそれを明確かつ簡潔に提示するために必要な情報を特定しました。
現在の Open Food Facts API サイトを確認しています。ドキュメントをよりユーザー フレンドリーに（一般ページ、読み取りページ、書き込みページ）に再構築して改善できると思います。さらに、開発チームと協力して、コードから API ドキュメントを自動的に生成する方法を設置したいと考えています（そのため、長時間のコラボレーションを提案します）。
見た目が重要であることは周知の事実です。そのため、REST API の CSS とロゴを調整して、Swagger UI をユーザー ドキュメントに合わせることもできます。
今後とも、どうぞよろしくお願いいたします。