← 모든 글

운영 도구의 README 첫 줄

8개 내부 도구의 README 를 다 다시 쓴 한 주.

운영 도구를 만들 때 README 첫 줄을 늘 미루다가, 8개 도구의 README 를 한 주에 다 정리.

첫 줄에 들어가는 것 (강제)

  1. 무엇을 한다 (한 줄)
  2. 누가 받는다 (사람 / 봇 / 다른 도구)
  3. 언제 실패하면 누구를 부른다 (텔레그램 채널 + 백업 담당)

이 세 가지가 없으면 6개월 뒤 본인도 “이 도구가 뭐였더라” 한다. 동료에겐 더 모호.

예시

# rss-digest-bot
매일 09:00 KST 에 RSS 30개 (`configs/feeds.yaml`) 를 한국어 한 줄 요약 → 슬랙 #news.
실패 시 텔레그램 @ops-alert. 1차 담당: mings, 백업: slecs.

세 줄. 그게 다.

다음에는 다르게 할 한 가지

새 도구의 첫 commit 에 README 의 첫 줄부터 둔다. 코드보다 먼저. README 의 첫 줄을 못 쓰면 도구의 목표가 아직 흐리다는 뜻이다.

🛒 이 글과 어울리는 추천 상품

위 링크는 쿠팡파트너스 활동의 일환이며, 일정액의 수수료를 제공받을 수 있습니다.