태그: #technical-writing
GPU·LLM·MLOps·쿠버네티스, 그리고 마음가짐에 관한 글 · 14 편
엔지니어의 쓰는 능력 — 설계 문서, 사고 보고서, 리뷰 코멘트가 하는 일
엔지니어에게 글쓰기가 중요하다는 말은 흔하지만, 왜 중요한지가 대개 승진 이야기로 끝납니다. 이 글은 다른 순서로 봅니다. 글은 먼저 사고의 검증 장치이고, 조직 안에서 반박 가능한 표면을 만드는 도구이며, 그 결과로 평가에 영향을 줍니다. 설계 문서에서 가장 중요한 것이 왜 버린 대안인지, 사고 보고서에서 사실과 해석을 나누는 것이 왜 정치가 아니라 기술인지, 리뷰 코멘트에 등급을 붙이는
2026-08-15 · 13 분 읽기 #career#skills#technical-writing#design-doc#postmortemDiátaxis를 네 개의 폴더로 오해하는 이유 — 한 문서 안에 두 모드를 섞으면 왜 무너지는가
Diátaxis는 문서를 튜토리얼·하우투·레퍼런스·설명 네 종류로 나눕니다. 그런데 팀 대부분은 폴더를 네 개 만드는 것으로 적용을 끝내고, 정작 문제는 그대로 남습니다. 진짜 실패는 분류가 아니라 한 문서 안에서 네 모드를 섞을 때 일어나기 때문입니다. 왜 섞이면 무너지는지를 프레임워크가 근거로 삼는 두 축에서 되짚고, 문단 단위로 판정하는 나침반과 이번 주에 바로 돌릴 수 있는 작업 루프
2026-08-09 · 15 분 읽기 #documentation#diataxis#technical-writing#developer-experience#information-architecture글로 일하는 개발자 — 디자인 독, ADR, 그리고 설득하는 테크니컬 라이팅
글쓰기가 시니어 엔지니어의 레버리지인 이유부터 디자인 독과 ADR의 실전 템플릿, 리뷰 받는 문서의 기술, 나쁜 문서 비포/애프터, AI를 글쓰기에 활용하는 법과 한계까지. 코드보다 문서가 먼저 평가되는 시대의 테크니컬 라이팅 가이드입니다.
2026-06-12 · 41 분 읽기 #technical-writing#design-docs#adr#documentation#careerAI 시대 개발자 영어: AGENTS.md, 시스템 프롬프트, RFC — 에이전트가 읽는 영어 쓰기의 기술
2026년 개발자가 쓰는 영어 중 가장 영향력이 큰 영어는, 사람이 아니라 에이전트가 읽는 영어입니다. AGENTS.md / CLAUDE.md 컨텍스트 파일, 프로덕션 에이전트의 시스템 프롬프트, 사람과 에이전트가 동시에 읽는 RFC / 디자인 독, 에이전트가 행동할 수 있는 이슈와 PR 설명까지 — '에이전트는 문자 그대로 읽는다(literal)'는 원칙을 중심으로 약한 영어와 강한 영어의
2026-05-14 · 43 분 읽기 #developer-english#ai-writing#agents-md#claude-md#system-prompt엔지니어링 글쓰기의 시대 — RFC·ADR·Design Doc·Amazon 6-pager·Eng Blog·Changelog·Slack·LLM 시대 글쓰기 심층 가이드 (2025)
글 잘 쓰는 엔지니어의 영향 반경은 10배다. RFC 프로세스·ADR·Design Doc·Amazon 6-pager·Stripe/Shopify/Uber/Airbnb 엔지니어링 블로그 운영·changelog·Slack/Email 비동기·LLM을 도구로 쓰면서 목소리 지키기·테크 인플루언서의 경제학까지 — 엔지니어 생존 스킬로서의 글쓰기 전부.
2026-04-15 · 22 분 읽기 #technical-writing#rfc#adr#design-doc#engineering-blog개발자를 위한 테크니컬 라이팅 가이드: RFC, ADR, 기술 블로그, API 문서 작성법
개발자 글쓰기의 모든 것! RFC(Request for Comments), ADR(Architecture Decision Records), API 문서(OpenAPI), README, CHANGELOG, 기술 블로그 작성법, 다이어그램(Mermaid/PlantUML), 문서화 문화까지.
2026-03-24 · 31 분 읽기 #technical-writing#documentation#rfc#adr#api-docs개발자를 위한 기술 문서 작성 완전 가이드: README부터 ADR까지
README부터 API 문서, ADR까지 개발자가 알아야 할 기술 문서 작성 전략과 Diátaxis 프레임워크, 그리고 문서화 도구들을 완벽히 정리했습니다.
2026-03-16 · 13 분 읽기 #documentation#technical-writing#soft-skills#developer#api-docs영어 보고서 작성법 완벽 가이드: Executive Summary부터 데이터 기반 보고까지
엔지니어를 위한 영어 보고서 작성 실전 가이드. Executive Summary, 기술 보고서, 장애 보고서, 주간 보고서 등 유형별 작성법과 핵심 표현을 정리합니다.
2026-03-13 · 8 분 읽기 #english#report-writing#technical-writing#communication#business-writing기술 보고서 작성 가이드: 구조 설계부터 데이터 시각화, 자동화까지
IT 엔지니어를 위한 기술 보고서 작성 완벽 가이드. 보고서 유형별 구조 설계, 피라미드 원칙, MECE 프레임워크, 데이터 시각화 기법, 마크다운 템플릿, 자동화 도구까지 실전 노하우를 정리합니다.
2026-03-13 · 29 분 읽기 #culture#report-writing#technical-writing#documentation#visualization기술 문서 영어 작성 가이드: RFC·ADR·Design Doc·Tech Spec 템플릿과 실전 표현
소프트웨어 엔지니어를 위한 기술 문서 영어 작성 가이드입니다. RFC, ADR, Design Doc, Tech Spec의 구조와 템플릿을 비교하고, 각 섹션별 핵심 영어 표현(Problem Statement, Proposed Solution, Alternatives Considered, Trade-offs, Success Metrics)과 리뷰 피드백 표현, 비영어권 화자의 흔한 실수까지 실
2026-03-12 · 31 분 읽기 #english#technical-writing#rfc#adr#design-doc영어 기술 문서 작성 완전 가이드: RFC·ADR·Design Doc 패턴과 실전 표현
글로벌 엔지니어링 팀에서 사용하는 영어 기술 문서 작성법을 체계적으로 다룹니다. RFC, ADR(Architecture Decision Record), Design Doc의 구조와 작성 패턴, 주요 영어 표현, 리뷰 코멘트 작성법까지 실전 예시와 함께 설명합니다.
2026-03-10 · 27 분 읽기 #english#technical-writing#rfc#adr#design-doc영어 인시던트 커뮤니케이션 완전 가이드: 장애 보고부터 포스트모템 작성까지 실전 표현
IT 엔지니어를 위한 영어 인시던트 커뮤니케이션 가이드. 장애 발생 초기 보고, 에스컬레이션, 상태 페이지 업데이트, 포스트모템 작성까지 실전에서 바로 쓸 수 있는 영어 표현과 템플릿을 제공합니다.
2026-03-08 · 40 분 읽기 #english#incident-communication#postmortem#sre#technical-writing영어 테크니컬 라이팅 실전 가이드: RFC, ADR, Design Doc 작성법과 템플릿
엔지니어를 위한 영어 기술 문서 작성법을 다룬다. RFC·ADR·Design Doc의 구조와 목적, 효과적인 영문 표현, 실전 템플릿과 리뷰 프로세스, 글로벌 팀 협업 커뮤니케이션 전략까지 포괄한다.
2026-03-06 · 37 분 읽기 #english#technical-writing#rfc#adr#design-docTechnical Writing 영어 가이드 — 개발자를 위한 기술 문서 작성법
README, API docs, RFC 작성법부터 명확한 문장 구조, 개발자가 흔히 하는 영어 실수까지 Technical Writing의 핵심을 정리합니다.
2026-03-03 · 8 분 읽기 #english#technical-writing#documentation#2026-03