목록 보기
[TW] 테크니컬 라이터와 Git
기타

[TW] 테크니컬 라이터와 Git

카카오엔터프라이즈
카카오엔터프라이즈
2023년 4월 5일

두줄요약

기술문서 작성과 배포에 Git과 Markdown을 활용하는 Docs as Code 흐름을 소개했습니다. 또한 카카오엔터프라이즈 팀의 실제 워크플로와 장단점을 함께 정리했습니다.

핵심 내용

  • 기술문서 작성·배포에 Git과 Markdown이 널리 쓰이는 배경 정리
  • Docs as Code 방식으로 문서를 코드처럼 버전 관리하고 자동 배포하는 흐름 설명
  • 카카오엔터프라이즈 테크니컬라이팅 팀의 초안 작성, 이관, 리뷰, 게시 워크플로 소개

장단점

  • 버전 관리, 백업, 협업, CI/CD 자동 배포의 장점
  • 구글 독스·위키 초안과 GitHub 최종본 이원화에 따른 싱크 관리 부담
  • Git 워크플로 미준수 시 병합 충돌 가능성

적용해볼 점

  • 초안은 유연한 협업 도구에서 작성하고 최종본은 Git으로 관리
  • 브랜치 분리와 정적 사이트 생성기로 로컬 확인 후 리뷰·게시
  • 초안과 게시본의 최신 상태 동기화 유지

다음 읽기

#문서화 주제를 다룬 다른 회사 글

5. Technical Writer, 사라질 결심

Technical Writer의 리뷰 기준과 작성 방식을 AI에 학습시켜 문서 작성과 리뷰를 자동화했습니다. 사내 메신저와 GitHub에 붙여 사용 흐름 안에서 바로 문서 작업이 되도록 만들었습니다.

토스
토스
AI

댓글 0

댓글을 작성하려면 로그인이 필요합니다.

댓글을 불러오는 중...