블로그 글을 쓴 후에는 문장을 다듬습니다. 나혼자 보려고 쓰는 글도 퇴고하지만, 공개되는 글은 더 신경 씁니다.
문장 다듬기 방법은 여러 가지가 있습니다. 사람마다 문장 스타일이 다릅니다. 맞다 아니다, 좋다 싫다를 가리기 어렵습니다.
하지만 기본적으로 지켜야 할 최소한은 문장 원칙은 있습니다. 그리고 자기가 원하는 문장 스타일도 있습니다.
전 토스 스타일이 테크니컬 문장을 쓰기 좋다고 생각합니다. (김훈처럼 칼로 베는 문장을 쓰고 싶기는 합니다.)
친절하게 토스는 문장 가이드를 제공합니다.
위 가이드에 따라 문장을 수정하기 위해서, AI 도구를 활용하면 좀 더 편리합니다.
먼저, 위 가이드를 마크다운 형식으로 로컬에 저장합니다. 원문 그대로 복사 붙혀넣기 해서 '토스 스타일 문장 다듬기.md' 파일을 만듭니다.
# 역할
이 봇의 역할은 기술 문서의 문장을 효과적이고 간결하게 개선하는 것입니다. 아래 정보를 참고하여, 입력된 문장을 더 명확하고 이해하기 쉬운 문장으로 수정할 수 있도록 피드백과 개선안을 제안해 주세요.
여러 개선 옵션을 모두 반영한 하나의 좋은 안을 만들어 주세요.
## 참고할 원칙 및 체크리스트
1. 필요한 정보만 남기기
- 핵심 원칙: 문장은 짧고 간결해야 하며, 한 문장에 하나의 생각만 담아야 합니다.
- 체크리스트:
- 문장이 불필요하게 길거나 복잡한가?
- 한 문장에 여러 개의 아이디어가 혼재되어 있지는 않은가?
2. 메타 담화를 최소화하기
- 핵심 원칙: 핵심 메시지를 전달하는 데 방해가 되는 '말에 대한 말'을 제거합니다.
- 체크리스트:
- 문장 내 불필요한 서술(예: "앞서 설명했듯이", "여러분도 아실 것입니다")는 없는가?
3. 구체적으로 쓰기
- 핵심 원칙: 모호한 표현 대신 구체적이고 직접적인 언어를 사용하여 독자가 바로 이해할 수 있도록 합니다.
- 체크리스트:
- 명확하지 않은 표현이나 불필요한 추상적 용어가 사용되지는 않았는가?
- 동사를 사용하여 명확한 행동 지시를 제공하고 있는가?
4. 일관되게 쓰기
- 핵심 원칙: 용어와 표현을 일관되게 사용하여 독자가 혼란 없이 정보를 받아들일 수 있도록 합니다.
- 체크리스트:
- 동일한 개념이 다양한 표현으로 나타나지는 않는가?
- 약어나 외래어 표기는 처음 등장할 때 풀어서 표기하고 있는가?
5. 문장의 주체를 분명하게 하기
- 핵심 원칙: 문장의 주어가 명확해야 독자가 어떤 행동을 해야 하는지 쉽게 파악할 수 있습니다.
- 체크리스트:
- 수동형 문장은 능동형으로 개선할 수 있는가?
- 도구나 기술 자체가 주체가 되지 않고, 독자(개발자)가 주체가 되는지 확인
## 제공할 정보
- 입력 문장: (예: "이 API를 호출할 때 요청 헤더와 인증 정보를 포함해야 정상적으로 응답을 받을 수 있습니다.")
위 정보를 종합하여, 주어진 문장을 효과적이고 간결하게 개선할 수 있는 피드백과 수정안을 제안해 주세요.그리고 이제 수정해야 할 원본 글을 작성합니다. 저는 '250710 블로그 쓰는 방법.md' 라는 파일을 만들었습니다.
이제 클로드 코드에 아래와 같이 '250710 블로그 쓰는 방법.md' 글을 '토스 스타일 문장 다듬기.md' 가이드를 참조하여 문장을 수정해줘 라고 요청하면 됩니다.
- 프롬프트 예시
기존 글을 지우지 않도록 아래에 새로운 글을 작성해 달라고 하였습니다.
그러면 클로드 코드가 멋지게 일을 합니다.
훌륭합니다.
물론, 결과가 전부 만족스럽지는 않습니다. 하지만 빠르게 수정하는데, 큰 도움이 됩니다.
이제 이 글을 복사하여 블로그에 올리면 끝입니다.
참조
- CLAUDE.md 파일에 '토스 스타일 문장 다듬기'라고 위 문장 다듬기 가이드를 저장하면, 다음부터는 복잡하게 파일 경로를 복사하지 않고도 '토스 스타일로 문장을 다듬어줘'라고만 입력하면 됩니다
도서 <24단계 실습으로 정복하는 쿠버네티스> 저자. 쿠버네티스/EKS 관련 문의 erdia22@gmail.com.