기능 설명 및 필요성
현재 개발자를 위한 Documentation과 사용자를 위한 Documentation이 제대로 관리되고 있지 않습니다.
사용자를 위한 문서는 Notion Page를 사용하고 있지만, 가독성이 떨어질 뿐더러 필수적인 정보들이 포함되어 있지 않아 개선이 필요합니다.
문서를 보충하면서 개발자 및 사용자를 위한 통합 Documentation 페이지를 Github Pages 를 사용해 호스팅하고, 코드플레이스에 About과 같은 탭으로 링크를 거는 것이 가장 좋은 방법으로 생각됩니다.
- 이 참에 체계적으로 문서 관리 방법을 확정할 필요가 있습니다.
예상 동작 방식
Github Pages를 이용해 Documentation 페이지를 생성합니다.
이 Documentation 페이지는 Developer 및 User 모두를 포함해야 하고, 첫 페이지에서 분기할 수 있도록 수정해야 합니다.
참고 자료
N/A
Acceptance Criteria
기능 설명 및 필요성
현재 개발자를 위한 Documentation과 사용자를 위한 Documentation이 제대로 관리되고 있지 않습니다.
사용자를 위한 문서는 Notion Page를 사용하고 있지만, 가독성이 떨어질 뿐더러 필수적인 정보들이 포함되어 있지 않아 개선이 필요합니다.
문서를 보충하면서 개발자 및 사용자를 위한 통합 Documentation 페이지를 Github Pages 를 사용해 호스팅하고, 코드플레이스에
About과 같은 탭으로 링크를 거는 것이 가장 좋은 방법으로 생각됩니다.예상 동작 방식
Github Pages를 이용해 Documentation 페이지를 생성합니다.
이 Documentation 페이지는 Developer 및 User 모두를 포함해야 하고, 첫 페이지에서 분기할 수 있도록 수정해야 합니다.
참고 자료
N/A
Acceptance Criteria