기술 문서는 제품 개발, 사용을 위한 모든 문서와 자료입니다. 이는 제품 사용법, 기능, 아키텍처를 설명하죠. 혹자는 '이메일을 비롯해 회사에서 작성하는 모든 문서'를 기술 문서로 보기도 합니다. 기술 문서는 사용자에게 기술 정보를 틀림 없이, 이해하기 쉽게 전달해야 합니다. 사용자는 기술 문서에서 필요한 정보를 빠르고 쉽게 얻을 수 있어야 합니다. 이 글은 정확하고, 잘 읽히며, 유용한 기술 문서를 쓰기 위해 고려할 사항을 담았습니다.

*이 글은 테크니컬 라이팅 일반 원칙, 문장 원칙을 주로 다뤘습니다. 글 내용은 앞으로 상황과 필요에 따라 추가, 수정될 수 있습니다.

*이 글은 할 일 목록(To-Do List) 형태로 작성했습니다. 각 항목을 체크하며 글을 점검하길 권장합니다.

*이 글은 인포그랩 내부 스타일 가이드로, 8번 (GitLab 관련) 영문 표기는 타사에 일괄로 적용하기에 맞지 않을 수 있습니다.

*이 글은 테크니컬 라이팅·웹 글쓰기·우리말 관련 도서, 마이크로소프트·구글·GitLab 스타일 가이드, 카카오 엔터프라이즈·NHN 클라우드·토스의 테크니컬 라이팅 콘텐츠 등을 참고해 작성했습니다. 각 참고 자료에서 공통으로 다룬 내용, 실무에 먼저 필요한 내용을 글에 반영했습니다. 자세한 참고 자료는 이 글 맨 하단에서 볼 수 있습니다.

이 글에서는 올해 DevOps 트렌드 가운데 5가지를 골라 살펴봅니다. 그동안 IT업계 전문가·기업, 관련 매체 등이 2023년 DevOps 트렌드를 다양하게 전망했는데요. 이 글에서는 여러 전망 가운데 3회 이상 지목된 트렌드 5개를 선정했고요. 해당 트렌드의 개념과 기능, 장점, 시장 전망, 성장요인 등을 들여다봤습니다. 2023년 DevOps 트렌드가 새롭지 않을 수도 있는데요. 그러나 반복해서 언급되는 개념을 따로 살펴보면 ‘업계에서 중요하게 생각하는 트렌드’를 쉽게 파악하는 데 도움될 수 있죠. 지금부터 하나하나 알아보겠습니다.

이번 포스팅에서는 Kubernetes 보안의 중요성을 강조하기 위해, 쿠버네티스를 해킹하여 secret 리소스에 저장된 비밀번호를 찾는 여러 가지 방법을 알아봅니다. 특히, etcd와 Pod를 해킹하는 실습으로 쿠버네티스 보안의 중요성을 알아보겠습니다.

GitLab의 중요한 기능 중 하나는 코드 빌드, 테스트 및 배포 과정을 자동화할 수 있는 CI/CD 파이프라인입니다. 그러나 프로젝트가 커지면 Job 수, 단계 수, 스크립트 및 의존성 수 등 많은 요소로 인해 파이프라인이 느려질 수 있습니다. 느린 파이프라인은 개발 프로세스에 부정적인 영향을 미칠 수 있으며, 시장 진입 시간이 증가하고 귀중한 자원을 낭비할 수 있습니다.

React는 사용자 인터페이스를 구축하기 위해 널리 사용되는 JavaScript 라이브러리입니다. 이 튜토리얼에서는 새로운 리액트 어플리케이션을 만들고 GitLab에서 CI 프로세스의 일부로 유닛 테스트를 실행하고 테스트 결과와 코드를 파이프라인에 출력하는 방법을 배울 수 있습니다.

오늘날 모든 회사는 소프트웨어 회사이므로 혁신 및 제공 수준이 수익 창출에 직접적인 영향을 미칩니다. 성공하기 위해 기업은 놀라운 디지털 경험을 제공하고, 최신 기술을 따라잡고, 고객이 요구하는 속도로 가치를 제공하고, 중단이나 보안 위반에 대해 무관용으로 모든 작업을 수행해야 합니다. 여기서 Value Stream Management(VSM)이 시작됩니다.

지난 MergeRequest로 개발 협업하기를 끝으로 디자이너, 개발자, PM이 서로 커뮤니케이션하고 협업하는 과정을 배워봤습니다.

하지만 구체적으로 뭐가 좋은지 아직 감이 안 잡히는 분들도 계실 겁니다.
그래서 역할별로 MR(Merge Request)의 장점을 총정리하는 시간을 가져 보겠습니다.

클라우드 시대가 되면서 인프라 엔지니어는 서버실에서 벗어나게 되었습니다. AWS 콘솔에서 클릭 몇 번으로 서버를 배포하고, 명령어 한 줄로 다양한 인프라를 구축할 수 있게 되었습니다. 더 나아가 인프라를 더 빠르고, 안전하게 관리하는 방법이 등장합니다.

지난 MergeRequest 만들기 포스트에서는 PM(Project Manager)이 이슈를 생성하고 디자이너와 협업하며 MR를 생성하는 부분까지 진행하였습니다.

이번엔 MR(MergeRequest)로 개발자와 협업하는 방법에 대해 자세히 알아보겠습니다.