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