TIL 기록 시스템을 WriterSide로 전환하다
계기 : 왜 TIL 환경을 Writerside 로 바꾸게 되었나?
기존 방식
파일 시스템 기반 : 디렉토리로 카테고리를 분리하고 글은
.md(markdown) 형식으로 작성.
백문이 불여일견 : https://github.com/yomni/til/tree/before-writerside
문제점
- 찾기 힘든 글 : 시간이 지나면 내가 쓴 글을 다시 찾아보는 일이 고역이 됨.
- 이미지 첨부 문제 : 본문에 이미지 삽입할 때 경로 설정이 배포되었다는 가정 하에 작성해야 되기 때문에 여간 귀찮은 일이 아니다..
결론 : 작성한 TIL을 다시 보지 않게 됐다. “내가 왜 썼더라?” 하는 순간이 자주 찾아옴.
writerside?
WriterSide는 Jetbrains 에서 개발한 문서 작성용 IDE로, 문서 작성에 최적화된 강력한 개발 환경
… (중략) 각설하고, 현재는 얼리 액세스 프로그램(EAP) 기간으로 무료로 사용 가능하다.
공식 소개글을 보면, Rest API Docs 을 대체할 수단으로도 활용이 가능 한 듯 하다.
jetbrains에서 제공하는 공식 문서들도 writerside 로 작성이 된 것도 있는 것 같고…
ex) Kotlin docs
주요 기능
- Docs-as-code : 코드를 기반으로 문서를 작성하고 관리
- 실시간 미리보기 : 로컬에서 변경 사항을 즉시 확인 가능
장점
- 심플한 디자인 : 디자인이 군더더기 없이 깔끔하다. 개발자 스럽다.
- 즉각적인 피드백 : 웹으로 리소스를 띄워 준실시간으로 변경점을 확인 할 수 있다.
- 집중된 환경 : 초기 설정만 잘 해놓으면, ‘글쓰기’라는 작업에만 몰입 할 수 있다.
단점
- 마이그레이션 작업 : 기존 글을 옮기는 과정에서 삽질을 좀 할 수 있다.
- 큰 단점이라곤 생각하지 않지만, 마이그레이션 해야 하는 글이 많으면 많을 수록 힘들 것 같긴 하다.
결과
WriterSide로 전환한 후 실제로 적용된 결과물은 아래 링크에서 확인 가능하다.
마무리
- WriterSide로의 전환은 단순히 새로운 도구를 도입한 것 이상의 경험이었다. 작업 환경이 효율적으로 바뀌었고, “글쓰기”라는 본질적인 작업에 더 집중할 수 있는 계기가 되었다.
- 다음 글에서는 마이그레이션 과정에서 겪은 문제들과 이를 해결했던 방법들을 자세히 다룰 예정이다. 혹시나 Writerside 를 도입하려고 한다면, 도움이 되길 바란다.