MelRanG
614
2021-03-11 19:37:47 작성 2021-03-11 19:38:34 수정됨
1
203

readme 질문입니다!


취준생 포폴용 프로젝트를 완성하고 readme는 열심히 작성해야 한다고 해서 작성중입니다!

길게하면 안본다고 간결하게 하라고 하시는 분도 꽤 많이 계시던데 간결하게 하는 게 좋을까요?


예를들어

프로젝트 소개를 한 후 이 프레임워크나 라이브러리를 선택한 이유를 설명할 수 있는 부분은 적어놓는게 좋을까요? 그냥 스킵하는게 좋을까요?


추가로 지금 제가 참고하고 있는 분의 readme 목차인데 이정도 길이의 목차는 괜찮은가요?

  • 들어가며

    1. 프로젝트 소개
      1-1. 프로젝트 기능
      1-2. 개발 환경
      1-3. 프로젝트 작동구조
      1-4. 실행영상
  • Front-End(React)

    1. 컴포넌트 구성
  • Back-End(Spring Framework)

    1. DataBase 테이블 설계
    2. Spring 설정파일 구성
      2-1. web.xml
      2-2. servlet-context.xml
    3. View 구성
    4. Controller 구성
    5. Model 구성
      5-1. DTO 구성
      5-2. DAO 구성
    6. Interceptor 구성
  • 마치며

    1. 프로젝트 보완사항
    2. 소감
0
  • 댓글 1

  • kenu
    54k
    2021-03-11 20:19:06
    해당 게시물은 관리자에 의해 Tech Q&A에서 포럼로 이동 되었습니다.
  • 로그인을 하시면 댓글을 등록할 수 있습니다.