Food Facts プロジェクトを開く
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
このページには、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 をユーザー ドキュメントに合わせることもできます。
このプロジェクトで一緒に取り組めることを楽しみにしています。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2024-11-08 UTC。
[[["わかりやすい","easyToUnderstand","thumb-up"],["問題の解決に役立った","solvedMyProblem","thumb-up"],["その他","otherUp","thumb-up"]],[["必要な情報がない","missingTheInformationINeed","thumb-down"],["複雑すぎる / 手順が多すぎる","tooComplicatedTooManySteps","thumb-down"],["最新ではない","outOfDate","thumb-down"],["翻訳に関する問題","translationIssue","thumb-down"],["サンプル / コードに問題がある","samplesCodeIssue","thumb-down"],["その他","otherDown","thumb-down"]],["最終更新日 2024-11-08 UTC。"],[[["This Google Season of Docs project focuses on improving the documentation of the Open Food Facts API to make it more user-friendly and comprehensive."],["The project aims to restructure the existing API documentation, potentially including the creation of general, read, and write sections for better organization."],["There are plans to implement automated API documentation generation directly from the codebase for ongoing accuracy and efficiency."],["The project may involve visual enhancements to the API documentation, such as aligning the Swagger UI styling with the user documentation using CSS and logo adjustments."],["This is a long-running project (5 months), allowing for in-depth collaboration with the Open Food Facts development teams."]]],["The core of this technical writing project involves enhancing the Open Food Facts API documentation. The writer, FutureOfDocs, aims to restructure and improve the user-friendliness of the existing documentation, including general, read, and write pages. A key action is to implement automated API documentation generation from the code. They also plan to refine the Swagger UI's CSS and logo to improve its visual alignment with user documentation, and contribute to providing the public with better food information.\n"]]
