이 페이지에는 Google 시즌의 Docs에 승인된 기술 글쓰기 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- OpenMRS.org
- 기술 문서 작성자:
- batbrain7
- 프로젝트 이름:
- OpenMRS REST API 문서
- 프로젝트 길이:
- 표준 기간 (3개월)
Project description
제안서를 여러 섹션으로 나누고 Google 지도 API 문서 및 GitHub API 문서와 같은 흐름을 따르겠습니다.
그 외에도 realworld.io에서 작성한 API 문서의 리드미 구조를 제안하고자 합니다. https://github.com/gothinkster/realworld/tree/master/api
개인적으로 이 문서는 이해하고 사용하기 매우 쉬웠습니다.
제 제안서는 크게 세 섹션으로 구성됩니다.
API, OpenMRS, API 사용 방법, 그 이후의 모든 내용을 간단히 소개하는 섹션입니다.
API 키를 가져오는 방법과 API 요청을 하는 데 일반적으로 필요한 인증을 알아봅니다. 여기에는 API에 있는 인증 유형과 인증에 필요한 키 및 값, 해당 부분의 키에 해당하는 허용되는 값 유형의 샘플 예시가 포함됩니다. 어떤 언어로든 코드 샘플은 API에서 헤더와 응답 형식 및 기타 쿼리 매개변수를 작성하는 방법을 지원하고 명확하게 보여줍니다.
API에서 가져오는 응답 유형, JSON 유형 또는 API에서 반환하는 기타 유형의 결과를 언급해야 합니다.
다양한 API 경로와 함께 전송해야 하는 모든 매개변수, 헤더, 기타 항목 각 API는 코드를 작성하는 동안 요청이 생성되는 방식을 설명하는 몇 가지 언어로 된 코드 샘플의 지원을 받습니다. 또한 각 API에서 발생할 수 있는 일반적인 오류 코드도 언급해야 합니다.
다음은 REST API에 관한 문서가 정의되는 방식에 대한 일반적인 개요입니다.
프로젝트 일정은 다음과 같습니다.
8월 1일~9월 1일
제 멘토와 함께 코드베이스의 다양한 부분에 필요한 문서 수준에 대해 자세히 논의하고 하위 수준 및 상위 수준 문서를 어떻게 심도 있게 다루는지도 논의합니다. 또한 이 시간 동안 코드베이스를 이해하고 개념을 연구하여 더 나은 문서를 작성할 수 있도록 하겠습니다.
1주차 및 2주차
참여자 가이드를 업데이트하고 확장하겠습니다. 소스 코드를 빌드하는 방법에 관한 문서를 개선하겠습니다. 또한 새로운 기여자가 문서에 어떻게 도움을 줄 수 있는지에 관한 문서 작성자 섹션도 추가할 예정입니다. 다양한 API 문서를 살펴보고 소개부터 시작하여 API 인증을 추가하겠습니다.
3~8주 차
각 유형의 API에 관한 몇 가지 코드 샘플과 함께 API 경로 및 응답을 추가하겠습니다 (유사한 유형의 API가 있을 수 있음).
9주 차 및 10주 차
링크를 사용하여 API 문서 구조를 추가합니다(예: 긴 API 문서의 링크된 색인). 그런 다음 코드 섹션, 개요, 매개변수, 루트 엔드포인트와 같은 다른 기준에 따라 이를 더 나누세요.
마지막 주
마지막 주에는 12주간의 문서화 기간 동안 수행한 작업에 관한 최종 보고서를 준비하겠습니다. 이 시간 동안 문서를 검토하고 완료할 예정입니다.