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