사전정의서 & 컨벤션
코딩 혹은 문서화를 할때 사용할 때 사용할 어휘들을 정의한다.
여기서 정의된 영어와 한글 단어는, 코딩의 변수명, 함수명, 엔티티명, DB의 테이블명, 컬럼명으로 쓰이게 된다.
길어지더라도 축약어는 최대한 피하기!
2021-06-10(목) by 노을
| 한글 | 영어 |
|---|---|
| 이슈 트래커 | Issue tracker |
| 사용자(writer와 assignee는 둘다 유저다) | User |
| 비밀번호 | Password |
| 로그인 | Login |
| GitHub 계정으로 로그인 | Login with Github |
| Apple 계정으로 로그인 | Login with Apple |
| 회원가입 | sign up |
| 토큰 | token |
| 이슈 목록 | Issues |
| 이슈 제목 | Issue Title |
| 이슈 내용 | Issue Content |
| 열린 이슈 | Open |
| 닫힌 이슈 | Closed |
| 레이블 | Label |
| 마일스톤 | Milestone |
| 담당자(이슈를 처리하는 사람) | Assignee |
| 작성자(이슈를 만든 사람) | Writer |
| 필터 | Filter |
| 내가 작성한 이슈 | Written issue |
| 나에게 할당된 이슈 | Assigned issue |
| 내가 댓글을 남긴 이슈 | Commented issue |
| 작성시간 | Writing time |
| 이모티콘 | Emoticon |
| 이미지 첨부하기 | Insert Photo |
| 레이블 설명 | Label Description |
| 레이블 배경색 | Label Background |
| 마일스톤 제목 | Milestone Title |
| 마일스톤 설명 | Milestone Description |
| 완료일 | Due date |
| 완료도(%) | Complete |
사전정의서에 나와 있는 용어를 참고하여, 용어들의 관계를 추상적으로 그려본다. 명심해야할 것은 엔티티는 데이터 테이블과 전혀 관계가 없다는 점이다. 대충대충 연필로 끄적여서 사진으로 찍어서 올리면 된다.
2021-06-10(목)
- 협의된 API 컨벤션 :
🐪카멜 케이스 - 자체 회원가입 기능 포기
- User의 email 필드는 프로젝트 진행 시 여유가 될 경우, 알림 시스템 구현을 위함
 |
 |
 |
|---|---|---|
 |
 |
 |
2021-06-09(수)
assign이나 comment 같은 부가 요소 없이 요구 사항을 크게 보고 작성해봤습니다.
 |
 |
 |
|---|---|---|
 |
 |
|