Skip to content
whatap-docs edited this page Aug 1, 2024 · 33 revisions

Welcome to the docs wiki!

Docs 문서 작업 기준에 대한 지침을 안내합니다. 당장 많은 것을 한번에 업데이트하지 못하기 때문에 필요할 때 작성해 업데이트하겠습니다.

문서 만들기

모든 문서의 파일명은 영어를 사용하고 하이픈을 이용하세요, 확장자는 mdx, 파일명은 문서 id와 같은 이름을 사용하세요.

파일명: about-agent.mdx

---
id: about-agent
title: 에이전트란?
description: 에이전트에 대한 설명입니다.
---

이미지 캡쳐 방식

  • 2023년 10월부터는 모든 이미지를 국어, 영어, 일어 기준으로 한번에 캡쳐해서 업로드합니다. 시간상 여건상 다국어 파일을 동시에 캡쳐하기 어렵다면 ImgLang 태그를 이용해 이미지 작업할 것, 추후에 다국어 이미지 파일만 추가하면 끝

    <ImgLang img='apm-dashboard.png' desc='애플리케이션 대시보드' />
    • ImgLang 태그를 이용하면 다국어 이미지가 없을 경우 한국어 이미지를 우선으로 출력하도록 설정되어 있습니다.
    • 다국어 이미지의 파일명은 국문 파일명 끝에 -en, -ja를 추가해야 합니다.
      예시, 국어 apm-dashboard.png / 영어 apm-dashboard-en.png / 일본어 apm-dashboard-ja.png
  • 웹 브라우저에서 이미지 캡쳐 기준은 가로 1692px 사이즈로 진행합니다.

  • 릴리스 노트의 캡쳐 이미지는 영문 기준으로 작성해 업로드합니다.

  • 이미지 캡쳐 프로그램은 기호에 맞게 이용하세요. 추천: shottr

Clone this wiki locally