개발 노트·회고를 일기장에 쓰는 법

오늘 한 작업, 막힌 것, 배운 것을 일기장에 남기는 습관. 코드 서식과 개발·문서 템플릿을 어떻게 쓰는지 정리했어요.

2분 읽기 · 갱신

일하다 보면 "그때 그걸 어떻게 고쳤더라"를 자꾸 되짚게 돼요. 하루 끝에 몇 줄만 남겨 두면 이런 질문에 답할 수 있어요. 일기장은 어차피 매일 여는 곳이라, 개발 노트를 따로 두지 않아도 돼요.

하루 끝 5분, 네 칸이면 충분해요

개발 노트 템플릿은 소제목이 넷이에요: 오늘 한 작업 · 막힌 것 · 알아낸 것 · 다음 할 일. 막힌 것을 적는 것만으로도 다음 날 어디서부터 시작할지 정해져요. 알아낸 것은 한 줄이면 돼요.

버그를 만났다면

버그·이슈 기록 템플릿은 증상 · 다시 일으키는 순서 · 기대한 결과 · 실제 결과 · 짐작한 원인 · 고친 방법 순서로 나뉘어 있어요. 고친 뒤에도 지우지 말고 두세요. 같은 증상을 다시 만나면 가장 빠른 길이 내 일기장이에요.

코드는 코드 서식으로

쓰는 동안 서식 막대의 [코드](</>)를 누르거나 Ctrl+E, 또는 줄 맨 앞에서 /code를 쓰면 그다음 쓰는 글이 고정폭 글꼴로 들어가요. 켠 채로 Enter를 누르면 다음 줄도 코드라서 여러 줄을 한 덩어리로 적을 수 있어요. 들여쓰기는 그대로 남아요.

Markdown으로 내보내면 코드는 ``` 블록이 되어서, 다른 문서 도구로 옮겨도 모양이 유지돼요.

코드 조각에 비밀번호·API 키·토큰을 그대로 적지 마세요. 일기장은 암호화되어 있어도, 내보내거나 화면을 공유하면 그대로 보여요. 회사 코드는 회사의 규정을 먼저 확인하세요.

배운 것을 모으는 오늘 배운 것(TIL)

오늘 배운 것 템플릿은 배운 것 · 배운 곳 · 더 알아볼 것 세 칸이에요. 짧게 쓰는 틀도 있어서 시간이 없는 날에도 부담이 없어요. 한 해가 지나면 한 해 돌아보기에서 어떤 태그를 많이 썼는지 볼 수 있어요.

한 주를 닫는 주간 업무 정리

금요일에 이번 주 한 일 · 진행 중인 일 · 막힌 것과 필요한 도움 · 다음 주 할 일을 적어 두면, 월요일 아침에 어디서 시작할지 바로 알 수 있어요. 이미 있는 하루 회고 KPT(계속할 것·아쉬운 것·해 볼 것)도 개발 회고에 잘 어울려요.

그 밖의 개발·문서 템플릿

템플릿은 쓴 글이 있어도 바꿔 가며 고를 수 있고, 새 글의 기본 템플릿도 정해 둘 수 있어요. 전체 목록은 템플릿 갤러리에서 미리 볼 수 있어요.

‹ 읽을거리 목록

밤글씨 받기

쓰는 기기에 맞는 스토어를 고르세요.