멈재

나만의 템플릿을 만들어보자 본문

생각 이야기

나만의 템플릿을 만들어보자

멈재 2023. 5. 8. 10:06
728x90

지난번에 성윤님이 발표하신 글또 세션인 '기술 블로그 운영에 어려움을 겪는 분들에게 전하는 이야기'를 듣고 쓰는 내용이다.
 
글쓰기 소재 선택,
글쓰기 준비 방법,
글쓰기 프로세스,
등 여러 내용들이 있었지만
 
내 경우에는 글재주가 부족하고, 문장을 다듬는 스킬이 부족해서 '나만의 템플릿'을 만들어본다고 이야기를 했었다.
 
 
그렇다면 '템플릿'이란 무엇일까?

출처: 나무위키

 
나무 위키에는 템플릿을 '어떤 것을 만들 때 안내 역할을 하는 사용상의 형식'을 나타낸다고 정의하고 있다.
 
글쓰기와 연관지어 이야기를 한다면,
특정 주제로 글을 작성함에 있어서 정해둔 형식에 맞게 작성하여 일관성 있는 구조를 가져가기 위함이다.
 
난 여기서 일관성이란 용어를 사용했는데 사용한 이유는 다음과 같다.
1. 상황에 따라 가독성이 좋아지는 게시물도 있겠지만 일반적으로 내 포스팅은 서론, 본론, 결론의 위치가 게시글마다 각기 다르다.
2. 어떻게 구조를 짜야하지 라는 생각에 글 쓰는 시간이 예상보다 길어진 적이 많다.
결국, 나무위키 마지막 문단에서 예시로 든 문장을 난 일관성이라고 표현한 것이다.
 
이처럼 노력과 시간을 줄이기 위해 나만의 템플릿을 만들어보았다.

서론
문제 상황 제시
이 문제가 왜 발생했는지

본론
이것은 무엇인지
- 분석
- 설명

결론
어떻게 해결해야 하는지
좋은 해결 방법은 무엇인지
(선택) 나의 의견

지금으로서 이 방법이 나와 맞을지, 맞지 않을지 아직 모른다.
그래도 분명한 것은 책도 여러 번의 수정 과정을 거쳐서 더 잘 갖춰지듯이 템플릿을 계속해서 수정해나가면 나에게 잘맞는 템플릿을 만들어 글의 완성도를 높일 수 있고, 노력과 시간을 아낄 수 있게 될 것이다.
 
 
몰랐는데 깃허브에서 이러한 템플릿 기능을 제공하고 있었고, 현재 이 템플릿을 만들어 토이 프로젝트에 적용하고 있다.
 
(Issues) Issue, PR 템플릿을 추가한다

[ADD] Issue, PR 템플릿을 추가한다 (BUG, FEATURE, PULL_REQUEST) · Issue #18 · cround-team/cround-server

기능 설명 Issue, PR 작성을 일관성있게 가져가기 위해 Issue, PR 템플릿을 추가한다. 기능 상세 BUG_FIX_TEMPLATE FEATURE_TEMPLATE PULL_REQUEST_TEMPLATE TODO 기타 논의 사항 PR-1, BUG_FIX, FEATURE TEAMPLTE PR-2, PULL_REQUEST_TE

github.com

 
템플릿을 설정 방법도 간단하고, 한번 만들어두면 계속해서 동일한 형식으로 쓸 수 있다는 것이 좋았다.
그 결과, 이슈(또는 PR)를 생성만 해도 지정해둔 형식으로 생성되게 되고 심지어는 assignees, labels도 지정할 수 있다.

 
 
더 나아가 우리가 습관이라는 것도 어떻게 보면 템플릿의 일종이다.
매일 이만큼의 분량을 할거야.
매주 한 번은 이만큼의 분량을 할 거야.
와 같은 것들도 결국엔 템플릿이다.
 
나의 활동을 돌아보며 일종의 반복되는 루틴이 존재한다면 포스팅의 내용처럼 템플릿을 만들어 시간과 노력을 줄여보려 한다.