인프런 커뮤니티 질문&답변

안녕하세요, 제로초님.

프론트엔드 문서화 관련하여 질문을 드릴 게 있습니다.

저희 회사에서 단기간에 규모가 큰 프로젝트를 진행하다보니 AI의 도움을 빌려 만들기는 만들었는데 문서화가 제대로 되지 않은 상태입니다.
최근 한 명의 백엔드 개발자가 프론트엔드도 함께 개발을 하게 되어 문서화의 필요성을 느끼고 있는데, 문서화에 대한 경험이 없어 제로초님께 여쭤봅니다.

현재 폴더 구조는 FSD를 채택하여 개발 중입니다.
구상중인 것은 Slice 단마다 문서를 만드려고 하는데,
해당 Slice에 포함된 파일의 사용 방식(API input값, output 값 등)에 대해 작성하고, store(zustand)에 저장된 값을 적고, ui에서 필요한 정보값들에 대해서도 적어보려고 합니다.

이렇게 모든 폴더에 정리하게 된다면 못해도 50개가 넘는 문서가 만들어지게 될텐데, 괜찮은 방법인지 확신하지 못하겠네요.(현재 회사에 있는 개발자분들은 딱히 관심이 없어보이십니다ㅠ)

제로초님이라면 해당 문서에 어떤 내용을 담으실지 궁금합니다.
그리고 프로젝트 전체를 소개하는 문서에는 Tech Stack, 프로젝트 구조 이외에 어떤 항목을 넣는 것이 좋을지도 궁금합니다.

이 수업에서 배운 디자인패턴에 대해서도 작성하는 것이 좋을까요?