Appearance

기술 사양서 편집하기 ​

이 가이드에서는 기존 기술 사양서를 편집하고 업데이트하는 방법을 안내합니다.

문서 편집 모드 진입하기 ​

1. 문서 목록에서 편집할 문서 선택 ​

문서 관리 화면에서 편집하려는 기술 사양서를 클릭하여 상세 보기로 이동합니다.

2. 편집 모드 전환 ​

상세 보기 화면에서 우측 상단의 "편집" 버튼을 클릭하여 편집 모드로 전환합니다.

기본 정보 수정 ​

"상세 정보" 아코디언을 클릭하여 기본 정보 섹션을 열고 필요한 정보를 수정합니다.

에디터 기능 활용하기 ​

서식 있는 텍스트 편집 ​

에디터는 다양한 서식 도구를 제공합니다:

  • 텍스트 스타일(굵게, 기울임, 밑줄 등)
  • 제목 및 문단 스타일
  • 글머리 기호 및 번호 매기기
  • 테이블 삽입 및 편집
  • 링크 및 이미지 삽입
  • 코드 블록 및 인용구

코드 블록 활용 ​

기술 사양서에서 코드 예제는 중요한 부분입니다. 에디터의 코드 블록 기능을 사용해 구문 강조가 적용된 코드를 삽입할 수 있습니다.

javascript
// 코드 예제
function calculateTotalPrice(items) {
  return items.reduce((total, item) => {
    return total + (item.price * item.quantity);
  }, 0);
}

테이블 활용 ​

데이터 구조나 API 엔드포인트 정보를 테이블 형태로 정리할 수 있습니다.

미리보기 모드 ​

작성 중 미리보기 모드를 사용하여 문서가 어떻게 표시될지 확인할 수 있습니다.

에디터 상단의 눈 아이콘을 클릭하여 미리보기 모드와 편집 모드 사이를 전환할 수 있습니다.

버전 관리 ​

새 버전 생성하기 ​

기존 문서의 새 버전을 만들려면:

  1. 문서 상세 보기 화면에서 우측 상단의 "..." 메뉴를 클릭합니다.
  2. "새 버전 추가" 옵션을 선택합니다.
  1. 변경 사항에 대한 설명을 입력합니다.
  2. 새 버전의 내용을 작성하고 저장합니다.

버전 히스토리 보기 ​

문서의 이전 버전들을 확인하려면:

  1. 문서 상세 보기 화면에서 우측 상단의 "..." 메뉴를 클릭합니다.
  2. "버전 히스토리" 옵션을 선택합니다.
  1. 버전 목록에서 확인하려는 버전을 선택합니다.

변경 사항 저장 ​

편집이 완료되면 우측 상단의 저장 버튼을 클릭하여 변경 사항을 저장합니다.

저장 시 상태를 선택할 수 있습니다:

  • 임시 저장: 작업 중인 상태로 저장
  • 검토 요청: 검토가 필요한 상태로 변경
  • 승인: 검토 완료 후 승인된 상태로 변경
  • 거부: 검토 후 수정이 필요한 상태로 변경
  • 완료: 모든 과정이 완료된 상태로 변경

작업 취소 ​

편집 중 작업을 취소하려면 "취소" 버튼을 클릭합니다. 저장하지 않은 변경 사항은 모두 손실됩니다.

Intellidesk

Copyright © 2025