본문 바로가기
devtools/Git, 협업 도구

[TIP] 문서화 가이드: 제목 작성 형식 - 간결하고 명확하게

by 신림쥐 2024. 3. 29.
728x90

제목을 작성하는 형식

  • 문서의 성격과 목적, 작성 규칙이 있다면 따르기
  • 주제를 명시적으로 간결하고 명확하게 작성  
  • 기존에 존재하는 파일과 제목이 통일

 

1. 주제를 요약하는 제목

예) "웹 브라우저 보안", "프론트엔드 성능 최적화", "데이터 관리 기술"

 

2. 의문형 제목

- 이슈를 제시하거나, 대답을 할 수 있게 질문을 한다.

예) "왜 웹 보안이 중요한가?", "어떻게 프론트엔드 성능을 향상시킬 수 있을까?", "쿠키 vs 세션"

 

3. 흥미 유발 제목

- '강화, 전략, 핵심, 요약' 키워드를 사용한다.

예) "웹 보안 강화 방법", "효율적인 프론트엔드 개발 전략", "데이터 관리의 핵심 원칙"

 

4. 요약

- 문서의 목차나 키워드를 나열한다.

예) "웹 보안: 중요성과 구현 방법", "웹 브라우저: 기본 개념과 구성 요소, 엔진, 보안, 버전 관리"

  • : 와 - 차이
  • 제목 - 특징 및 결과
    • 주제의 핵심을 강조
  • 제목: 특징 및 결과
    • 제목을 보충하거나 설명
728x90