개발자의 Notion 활용하기

개발자의 Notion 활용하기

  • 나는 개발자로 일하면서 만난 이슈들과 여러가지 시도한 방법들 그리고 해결한 방법을
    개인적으로 Notion에 보드를 따로 만들어서 관리하고 있다.
  • markdown 문서로 하나 하나 일일이 만드는 것보다 좋은 점을 느껴서
    Notion을 활용하는 이유를 적고자 한다.

개발 일정에 Notion을 활용하는 이유

  • 보드에 블럭 단위로 관리하고 그 안에 코드와 함께 내가 작성한 기획 문서나 순서도 등을
    넣을 수 있어서 좋다고 느낀다.
  • Notion에 작성한 파일을 마크다운 문서다운 받을 수 있다.
    (단, 다운 받을 때는 depth가 있어서 바로 마크다운 문서 1개의 파일이 아닌 압축 파일로 다운 받아진다.)

  • 파일의 depth무제한이다.

    • 마크다운 문서의 형태로 포스팅을 하면서 depth가 깊지 않아 불편함을 많이 느꼈다.
      (ex) 현재 블로그 카테고리의 depth는
      개발자- til 두 단계까지만 가능하다.)
    • Notion은 무료 회원일 경우 블럭을 1,000개까지 무료 생성할 수 있고,
      유료 회원의 경우 블럭 안에 블럭 그 안에 블럭..을 끝없이 만들 수 있다.

Notion을 개발에 활용하는 방법(개인적인 활용법)

  • 나의 경우에는 개발 관련 보드를 따로 만들었다.
    (ex) Tasks & Issues보드를 생성한다.)

  • 보드의 구성은 To-do, doing, done, issues, today, nextup으로 구성하였다.
    • To-do, doing, done 탭은 이번 개발 마지노선 기간까지 완료할 일을 적고 활용하는 구간이다.

    • issues에는 개발을 하면서 어려운 점이 있거나 이슈가 발생했을 때,
      에러 메시지, 시도한 방안, 해결 방법, 참고 링크 등을 정리해둔다.

    • today는 오늘 개발할 일정을 정리해두는 탭이다.
      To-do, doing 탭에 있는 기능들 중 오늘 구현할 내용들을 드로그 앤 드롭으로
      today 탭에 넣는다.

    • nextup은 이번 기능 개발 마지노선 이후에 추가로 구현할 기능이나 추후 개발할 내용에 대해 정리해두는 탭이다.
      (ex) 이번 개발 마지노선까지는 날씨 정보에 대해 [시/도] 단위까지 구현하는 게 목표라면,
      nextup에는 [구/군], [읍/면/동] 단위까지 구현하는 일정을 적어둔다.)

  • 큰 개발 일정을 적어두고, 블럭 단위로 큰 개발 목표 구현을 위해
    세세하게 구현해야 할 기능들블럭 단위로 만든다.

  • 그 후, 개발에 대한 결과물을 내야 하는 마지노선 일자를 적어둔 후,
    To-do 탭 안에 기능 단위로 나뉘어진 블록 안에 그 기능을 구현하기 위해 할 일을 To-do list의 형태로 적어둔다.
    (개발하면서 추가, 수정, 삭제될 수 있다.)
    (분명 예상보다 이슈 등을 만나면 일정에 차질에 생길 수 있으므로 버퍼 1~2일을 미리 계산해둔다.)

  • To-do탭 안에 있는 To-do list의 일들을 체크박스에 하나씩 체크 표시하면서 개발을 진행한다.
    (이렇게 개발을 진행할 경우, 중간에 수정사항이 생기거나 추가 기능이 생겨도 빠짐없이 구현할 수 있다.
    특히 일정이 타이트할 경우에도 To-do list를 보고 차근차근 하나씩 클리어하면 되므로 멘붕에 빠지는 걸 방지할 수 있었다.)

  • To-do에서 doing을 거쳐 블록 안에 작성된 To-list 체크박스 항목들을 다 완료하면, done탭으로 옮긴다.
    (만약 done탭으로 옮겨진 기능에 에러가 생기면 다시 to-do탭으로 옮기고, 블럭 안에 to-do list를 추가한다. )

개발 이슈에 대한 정리

  • 사람은 똑같은 실수를 반복하기 마련이다. 그건 개발자도 예외가 아니다.

  • 해당 이슈를 해결한 경험이 있더라도 사람의 기억력에는 한계가 있기 때문에 정리해두어서 꺼내 쓸 수 있어야 한다는 생각이 들었다.

  • 습관적으로 틀리는 부분을 반복하기 때문에 겪었던 이슈를 적어두고 이에 대해 시도한 방안들, 해결한 방안들을 정리해둔다.

  • 나만의 이슈 해결 라이브러리라고 볼 수 있다.

  • 이슈를 만날 경우, 해당 발생 이슈블럭 하나를 생성해서 제목에 적는다.

  • 내용에는 참고한 링크를 넣고, 시도한 방안, 해결 방법과 함께 해당 부분의 코드를 적는다.

  • 코드를 넣을 때는 이슈가 발생한 코드와 이슈를 해결한 코드 2가지를 함께 넣는다.(추후 비교해서 확인하기 위해)

  • 시도한 방안해결 방법을 나누어서 적는 이유는 내가 한 이슈에 대해서 어떤 시도를 했으며 이 시도가
    작용하지 않는 이유, 결론을 찾는 절차를 정리하기 위함이다.

  • 아래 그림은 내가 작성한 Notion에 이슈를 정리한 예시이다.
    Notion- encodeURI 이슈 예시