본문으로 건너뛰기

하이라이트

YAML의 거의 모든 것

YAML은 데이터 직렬화 언어로, 구성 파일 작성, DevOps 도구의 스크립팅과 자동화 프로세스 정의, CI/CD 파이프라인 구성 등에 쓰입니다. 이 글은 YAML 특징과 구문, 활용 사례를 알아보고요. DevOps 핵심 워크플로인 CI/CD 파이프라인에서 YAML 의의를 살펴봤습니다.

자세히 보기

"Technical Writing" 태그와 연관된 1개의 게시물이 있습니다.

모든 태그 보기
테크니컬 라이팅 깔끔하게 완성하는 10가지 원칙테크니컬 라이팅 깔끔하게 완성하는 10가지 원칙

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

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

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

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

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

Grace
Grace | Technical Writer