이 페이지에는 Google Season of Docs에서 수락된 기술 작문 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- 공개 음식 정보
- 테크니컬 라이터:
- FutureOfDocs
- 프로젝트 이름:
- Open Food Facts API 문서화
- 프로젝트 기간:
- 장기 실행 (5개월)
Project description
몇 달 전에 수강한 REST API 문서 관련 과정의 강사로부터 이메일을 통해 'Season of Docs'에 관해 처음 들었습니다. 아이디어도 마음에 들었지만 그 프로젝트를 잘 이해할 수 있어야만 신청할 수 있었죠. 제가 하는 일과는 별개로 하는 일이며, 그렇게 된다면 재미있고 의미 있는 일이 될 것입니다.
Open Food Facts에 대한 설명을 읽고 그 프로젝트를 찾았다는 것을 알았습니다. 저는 운동과 음식을 통해 내 몸과 건강을 돌보는 것을 좋아합니다. 저는 영양이 행복한 삶을 위한 열쇠 중 하나라고 생각합니다. 우리 모두 더 나은 선택을 할 수 있어야 합니다. 우리가 사용하는 음식과 화장품에 대한 충분한 정보를 가지고 있어야만 가능합니다. Open Food Facts는 이 정보를 자유롭게 사용할 수 있도록 지원하며 이 놀라운 이니셔티브에 기여하고자 합니다.
지난 3년 동안 저는 프로세스 및 출시 자동화를 전문으로 하는 소프트웨어 개발 회사에서 테크니컬 라이터로 일했습니다. 무엇보다도 우리는 개발자가 API 요청을 통해 Google 애플리케이션과 통신할 수 있도록 Swagger를 사용하여 REST API를 구현했습니다. 저는 개발팀이 요청/응답에 대해 더 나은 설명을 작성할 수 있도록 지원했으며, 고객이 명확하고 간결하게 제공하는 데 필요한 정보를 파악했습니다.
현재 Open Food Facts API 사이트를 검토 중이며 더 사용자 친화적 (일반, 읽기, 쓰기 페이지)으로 문서를 재구성하고 개선할 수 있을 것 같습니다. 또한 코드로부터 API 문서를 자동으로 생성할 수 있는 방법을 개발팀과 함께 설정하고 싶습니다 (시간이 걸리기 때문에 장기적 협업을 제안합니다).
우리는 디자인이 중요하다는 것을 알고 있습니다. ;) 따라서 우리는 REST API CSS와 로고를 조정하여 swagger UI를 사용자 문서에 일치시킬 수 있습니다.
이 프로젝트를 함께할 수 있기를 기대합니다.