Food Facts 프로젝트 열기

이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 구성:

식품 정보 열기

기술 문서 작성자:

FutureOfDocs

프로젝트 이름:

Open Food Facts API 문서화

프로젝트 길이:

장기 실행 (5개월)

Project description

몇 개월 전에 수강한 REST API 문서에 관한 과정의 강사로부터 받은 이메일을 통해 '문서 시즌'에 대해 처음 알게 되었습니다. 아이디어는 마음에 들었지만, 제가 공감할 수 있는 프로젝트에만 지원하기로 결정했습니다. 평소 직장 외에는 다른 일을 하고 싶었고, 해낸다면 재미있고 의미 있을 것 같습니다.

Open Food Facts에 대한 설명을 읽었을 때 그 프로젝트를 찾았다는 걸 알게 됐어요. 운동과 음식을 통해 몸과 건강을 관리하는 것을 좋아합니다. 영양은 행복한 삶의 열쇠 중 하나라고 생각합니다. 모두가 더 나은 선택을 할 수 있어야 하며, 이를 위해서는 우리가 사용하는 식품과 화장품에 관한 충분한 정보를 가지고 있어야 합니다. Open Food Facts는 이러한 정보를 제공하고 있으며, 저는 이 멋진 이니셔티브에 기여하고자 합니다.

지난 3년간 프로세스 및 출시 자동화에 특화된 소프트웨어 개발 회사에서 기술 작가로 일했습니다. 그중에서도 개발자가 API 요청을 통해 애플리케이션과 통신할 수 있는 Swagger를 사용한 REST API를 구현했습니다. 저는 개발팀이 요청/응답에 대해 더 나은 설명을 작성할 수 있도록 지원했으며, 고객이 정보를 명확하고 간결하게 제공하는 데 필요한 정보를 파악했습니다.

현재 Open Food Facts API 사이트를 검토한 결과, 문서를 재구성하고 개선하여 더 사용자 친화적으로 만들 수 있을 것 같습니다 (일반, 읽기, 쓰기 페이지). 또한 개발팀과 함께 코드에서 API 문서를 자동으로 생성하는 방법을 설정하고자 합니다. 이 작업에는 시간이 걸리므로 장기적인 공동작업을 제안합니다.

디자인이 중요하다는 것은 모두 알고 있습니다. ;) 따라서 REST API CSS 및 로고를 조정하여 스와거 UI를 사용자 문서와 일치시킬 수도 있습니다.

이 프로젝트에서 함께할 수 있기를 기대합니다.