기본 패턴
text
- [ ] 로그인 화면 구현
- [x] API 응답 형식 정리
- [ ] 문서 업데이트설명
- task list는 목록 항목 앞에 체크박스 문법을 붙여 진행 상태를 시각적으로 표시하는 방식입니다.
- GitHub 이슈와 PR에서는 체크박스를 클릭해 완료 상태를 바로 바꿀 수 있어 협업 도구 역할도 합니다.
- 단순한 bullet 목록보다 실행 상태를 보여 주기 좋기 때문에 작업 계획 문서에서 특히 자주 쓰입니다.
- GitHub 문서 기준으로 tasklist blocks 자체는 은퇴했지만, Markdown 체크리스트 문법은 계속 널리 사용됩니다.
짧은 예제
text
## 릴리스 준비
- [x] 버전 태그 정리
- [ ] 변경 로그 작성
- [ ] 배포 후 smoke test빠른 정리
| 문법 | 설명 |
|---|---|
- [ ] item | 미완료 작업 |
- [x] item | 완료 작업 |
| 진행 표시 | 일반 목록보다 상태 추적에 유리 |
| GitHub 클릭 동작 | 이슈/PR에서는 체크 상태를 UI에서 바꿀 수 있음 |
| 작업 문서화 | 릴리스 체크리스트, TODO 정리에 적합 |
주의할 점
체크리스트는 실행 상태를 드러내는 도구이지 설계를 대신하지는 않습니다. 항목이 너무 크면 체크 여부만으로 실제 진행 상황을 알기 어려워집니다.
참고 링크
2 sources