Readme 작성
Readme는 레포지토리를 방문한 사람들에게 “이 프로젝트는 무엇인지” 를 알기 쉽게 전달해주는 중요한 역할을 한다고 한다. 오늘은 각자 겪었던 트러블 슈팅에 대해서 Readme를 작성하고, 이를 ppt로 만드는 작업을 했다.
Key Summary라는 목차에 토글로 '핵심 성능 개선'과 '트러블 슈팅'을 작성해주었다. 마크 다운에서는 토글 문법을 지원하지 않는다. 우리는 html의 태그를 사용해서 토글 기능을 사용할 수 있다. 예시 코드는 아래와 같다.
<details>
<summary>토글 접기/펼치기</summary>
<div markdown="1">
내용을 작성하세요.
</div>
</details>
여기서 <div markdown="1">는 작성해도 되고, 작성하지 않아도 되는 것 같다. <div markdown="1">은 해당 토글 내부에 마크다운 형식의 텍스트를 사용할 수 있도록 지정하는 역할을 한다고 한다. 그러나 이를 사용하지 않아도 토글 기능은 정상적으로 작동했다.
핵심 성능 개선
이 부분에는 내가 구현한 기능과 그에 대한 로직, 기능을 구현하게 된 배경 등에 대해 작성해주었다. 로그인 페이지와 채팅 페이지를 분리하고, 대화 세션을 관리한 것에 대해 작성했다. 로그인 시 채팅 페이지로 넘어가게 하고, 하나의 대화 세션에서는 하나의 버튼만 생성되게 한 것에 대해 내용을 채워나갔다.
트러블 슈팅
성능과 코드를 개선한 것에 대한 요약을 먼저 작성했다. 그리고 발생한 문제와 문제가 발생한 원인, 해결 방안 등에 대해 작성해주었다. 함수를 수정하면서 IndexError가 발생했는데, 이를 해결하기 위해 코드를 수정하고 예외처리를 한 것에 대해 내용을 채웠다. 회고 부분도 작성해주었다.