PHpullh

WRITING TEMPLATE

개발 노트 작성 템플릿

data/developer-notes.js에서 template 객체를 복사해 채운 뒤 status를 published로 설정하고 생성 명령을 실행하세요.

글의 흐름

  1. 한 줄 결론
  2. 상황과 문제
  3. 결정 과정과 트레이드오프
  4. 구현·실험·검증
  5. 결과 수치
  6. 재사용할 원칙과 체크리스트

데이터 예시

{
  "slug": "example-note",
  "status": "draft",
  "title": "문제와 결정을 한 문장으로 설명하는 제목",
  "description": "검색 결과에 표시할 1~2문장 요약입니다. 무엇을 해결했고 누구에게 도움이 되는지 적습니다.",
  "category": "Engineering Note",
  "tags": [
    "Kotlin",
    "운영",
    "회고"
  ],
  "datePublished": "2026-07-25",
  "dateModified": "2026-07-25",
  "readingTime": "6분",
  "summary": "글 전체의 결론을 먼저 적습니다. 독자가 이 글을 읽고 가져갈 판단 기준을 한두 문장으로 정리하세요.",
  "situation": "어떤 제품, 시스템, 팀 상황에서 문제가 발생했는지 적습니다. 수치·제약·전제조건을 가능한 한 구체적으로 남기세요.",
  "decisions": [
    {
      "title": "결정 1",
      "body": "검토한 선택지와 이 결정을 택한 이유를 적습니다."
    },
    {
      "title": "결정 2",
      "body": "트레이드오프와 포기한 대안을 적습니다."
    }
  ],
  "implementation": [
    {
      "title": "구현 또는 실험",
      "body": "바꾼 내용과 검증 방법을 적습니다.",
      "language": "text",
      "code": "핵심 설정, 코드, 쿼리 또는 명령어를 붙여 넣으세요."
    }
  ],
  "results": "배포 뒤의 결과를 적습니다. 가능하면 지연 시간, 오류율, 비용, 리드타임 같은 전후 수치를 포함하세요.",
  "lessons": [
    "다음에도 재사용할 원칙",
    "처음부터 확인했어야 했던 신호",
    "다른 팀에 전달할 수 있는 체크 포인트"
  ],
  "checklist": [
    "재현 조건을 기록했다",
    "대안을 비교했다",
    "결과를 수치로 확인했다"
  ],
  "references": [
    {
      "label": "관련 PR 또는 공식 문서",
      "url": "https://example.com"
    }
  ]
}