시작하기
이 블로그는 기술 문서를 잘 쓰고 싶다는 문제의식에서 시작됐어요.
회사에서 일하면서 인수인계 문서가 없거나,
있더라도 왜 이렇게 구성됐는지 알 수 없는 문서를 자주 마주했어요.
코드와 서버는 남아 있는데, 맥락은 사라진 상태였죠.
그때 자연스럽게 이런 생각이 들었어요.
기술적인 문제보다 더 큰 문제는
“설명되지 않은 상태”일지도 모른다.
그래서 글쓰기를 잘해보고 싶어졌고,
그 과정에서 토스 테크니컬 라이팅 가이드를 접하게 됐어요.
이 블로그는 그 가이드를 참고해
글을 잘 쓰는 연습을 하고, 배운 것과 경험한 것을 정리하기 위한 공간이에요.
이 블로그에서 다루는 것
이 블로그는 “정답을 알려주는 문서”라기보다는
생각하고, 정리하고, 기록하는 과정에 가까워요.
주로 이런 내용을 다뤄요.
- 회사에서 겪은 개발·운영·인수인계 경험
- 기술 문서를 쓰면서 고민했던 구조와 표현
- 토스 테크니컬 라이팅 가이드를 읽고 정리한 내용
- 글을 고치면서 배운 점과 시행착오
- 나중의 내가 다시 봐도 이해할 수 있도록 남긴 기록
완성도 높은 글도 있지만,
연습에 가까운 글도 함께 올라올 수 있어요.
왜 테크니컬 라이팅인가
테크니컬 라이팅은 단순히 “글을 잘 쓰는 것”과는 조금 달라요.
중요한 건 멋진 문장이 아니라 전달되는 문장이에요.
- 읽는 사람이 누구인지
- 어떤 상황에서 이 글을 읽을지
- 이 글을 읽고 무엇을 할 수 있어야 하는지
이걸 계속 고민하게 만드는 게
테크니컬 라이팅이라고 생각해요.
이 블로그는 그 고민을 계속 기록하는 공간이에요.
이 블로그의 글은 이렇게 쓰려고 해요
이 블로그의 글은 먼저 문서 유형을 정하는 것부터 시작해요.
같은 주제라도
학습을 위한 글인지,
문제를 해결하기 위한 글인지,
참고용 문서인지에 따라
글의 구조와 설명 방식은 달라진다고 생각해요.
그래서 글을 쓰기 전에,
- 이 글은 어떤 목적의 문서인지
- 독자는 무엇을 알고 싶어 하는지
를 먼저 정한 뒤,
그에 맞는 형식과 구조로 글을 작성하려고 해요.
아래 글부터는
이 블로그에서 사용하는 문서 유형과,
각 유형을 어떻게 구분하고 활용하려고 하는지를 정리해요.
참고사항
- 이 블로그의 글은 전부 개인적인 경험과 학습 내용을 바탕으로 작성돼요.
- 특정 회사나 시스템을 직접적으로 지칭하지 않도록 일부 맥락은 일반화되어 있어요.
이 블로그의 목적
이 블로그의 목적은 단순해요.
글을 잘 쓰는 사람이 되기 위해,
계속 써보고, 고쳐보고, 남겨두는 것.
그리고 언젠가,
- 인수인계 문서를 써야 할 때
- 기술을 설명해야 할 때
- 과거의 결정을 다시 이해해야 할 때
이 기록들이 도움이 되기를 바라고 있어요.