리드미(README)란?
리드미는 마크다운문법을 사용한 파일로 일반 텍스트 파일과 다르게 디자인이 가능하여 가독성이 좋은 것이 특징입니다.
또한 리드미는 프로젝트를 진행 중이라면 구현 중인 프로젝트를 정리, 완성이 됐다면 완성 프로젝트를 설명하는데 쓰이는데요. 이처럼 서로의 이해를 돕기 위해 만든 파일을 리드미(README)라고 합니다.
리드미(README) 작성이유
리드미를 작성하는 이유로는 총 3가지가 있습니다.
- 나를 위해서 : 내가 코드를 짰는데 필요할까 싶지만 생각보다 시간이 지난 다음 내 코드를 보면 기억이 안나는 경우가 있기 때문에 일일이 찾아보기보다 리드미를 읽고 이해할 수 있도록 작성합니다.
- 팀을 위해서 : 당연히 팀원들이 어디까지 작업을 했는지 확인할 수 있게 작성합니다.
- 사용자를 위해서 : API나 오픈소스들을 만들면 사용자들이 어떻게 사용하면 되는지 지침서 역할을 하기 때문에 작성합니다.
그렇다면 리드미에 어떤 내용을 포함해야 하나요?
리드미(README)에 넣을 내용
- 프로젝트명과 팀원 소개
- 프로젝트에서 사용된 언어와 프레임워크
- 프로젝트의 기능과 목적
- 폴더구조
- 코드컨벤션
- 트러블슈팅과 해결
- 라이선스
리드미 작성에 정답은 없지만 리드미에 들어가면 좋을 내용들을 대략적으로 적어보았습니다.
프로젝트명
프로젝트를 알리는 프로젝트명은 꼭 들어가야 합니다.
프로젝트 팀원소개
프로젝트의 팀원을 소개할 때는 단순히 참여자 이름만 작성하는 게 아니라
해당 참여자가 무슨 작업을 했는지 같이 작성해 주면 좋습니다.
사용 언어와 프레임워크
프로젝트에서 사용한 언어와 그리고 프레임워크를 작성해 줍니다.
프로젝트의 기능과 목적
해당프로젝트의 목적을 작성하고 어떤 서비스가 존재하는지 간단하게 작성을 해주면 좋습니다.
프로젝트의 폴더구조와 파일
어떤 폴더구조로 되어있는지 파일마다 어떤 기능이 있는지 정리해서 사용자들이 알기 쉽게 정리해 줍니다.
코드컨벤션
프로젝트를 진행하면서 코드 작성할 때 규칙을 정하는데 이를 코드컨벤션이라고 합니다. 변수나 함수, 클래스, 메서드 같은 이름을 정하는 것부터 들여 쓰기는 몇으로 하는지 탭으로 하는지 스페이스로 하는지 등등 사소한 것까지 작성해 줍니다.
트러블슈팅과 해결
프로젝트를 진행하면서 발생했던 이슈들을 정리하고 해당 내용들을 어떻게 해결했는지 작성해 줍니다.
라이선스
마지막으로 라이선스에 관한 정리를 해줍니다.
오늘도 화이팅🐣
'프로젝트 > 프로젝트 관리' 카테고리의 다른 글
| [git] git 명령어 (init, remote, add, commit, log, status, push, pull) (0) | 2023.12.02 |
|---|---|
| [git] git add와 staging area (0) | 2023.12.01 |
| [git] git 과 github 시작하기 (0) | 2023.12.01 |
| 버전 관리 시스템 (0) | 2023.12.01 |
| 마크다운 문법 정리 (0) | 2023.12.01 |
