코드가 포함된 기술 문서는 구조가 명확해야 합니다. 들여쓰기, 공백, 그리고 의미 있는 URL 구조가 문서의 품질을 결정합니다.

좋은 기술 문서의 특징:

• 명확한 구조: 헤더, 리스트, 코드 블록이 일관되게 정리됨
• 적절한 공백: 문단 사이, 코드 블록 주변에 적절한 여백
• 일관된 포맷: 들여쓰기, 리스트 스타일, 코드 블록 형식이 통일됨
• SEO 친화적: 의미 있는 URL 슬러그와 메타 정보

일반적인 문제점:

• 헤더(#) 뒤에 공백이 없음: #제목 → # 제목
• 리스트(-) 뒤에 공백이 없음: -항목 → - 항목
• 연속된 빈 줄이 너무 많음: 3줄 이상의 빈 줄
• 탭과 공백이 섞여 있음: 일관성 없는 들여쓰기
• 코드 블록 주변 공백이 없음: 가독성 저하

자동화의 장점:

• 시간 절약: 수동으로 정리하는데 30분 걸릴 작업을 1분에 완료
• 일관성: 모든 문서가 동일한 포맷 규칙을 따름
• 실수 방지: 놓친 부분을 자동으로 찾아서 수정

작성하다 보면 꼬이기 쉬운 마크다운 들여쓰기와 공백을 정리하세요. 마크다운 포맷 정리 도구가 문서의 구조를 깔끔하게 잡아줍니다.

작업 순서:

• 정리할 마크다운 문서를 복사합니다
• '마크다운 포맷 정리' 도구에 붙여넣습니다
• 필요한 옵션을 선택합니다:
• - 헤더(#) 띄어쓰기 교정: #제목 → # 제목
• - 리스트(-, 1.) 띄어쓰기 교정: -항목 → - 항목
• - 연속 빈 줄 1줄로 줄이기: 3줄 이상 빈 줄을 1줄로
• - 탭(Tab)을 공백 2개로 변환: 일관된 들여쓰기
• 미리보기에서 결과를 확인합니다
• 만족스러우면 결과를 복사하여 사용합니다

정리 전 예시:

#제목
-항목1
-항목2


##부제목
1.번호1
2.번호2

정리 후 예시:

# 제목
항목1
항목2
부제목
번호1
번호2

팁:

• AI가 생성한 마크다운이나 여러 소스를 합친 문서를 정리할 때 특히 유용합니다
• 정리 후에도 내용은 그대로 유지되므로 안심하고 사용할 수 있습니다
• 깃허브 README, 노션, 기술 블로그 등 어디든 바로 사용 가능합니다

문서의 제목을 URL로 사용할 때는 영문 소문자와 하이픈(-)으로 구성된 슬러그가 좋습니다. 슬러그 생성기로 제목을 URL 친화적으로 변환하세요.

작업 순서:

• 문서의 제목을 '슬러그 생성기' 도구에 입력합니다
• 영문 제목인 경우 '불용어 제거' 옵션을 선택할 수 있습니다 (a, the, of 등 제거)
• 자동으로 생성된 슬러그를 확인합니다
• '슬러그 복사하기' 버튼을 클릭하여 복사합니다

슬러그 변환 예시:

• 한글 제목: 'React Hooks 완벽 가이드' → 'react-hooks-wanbyeog-gaideu'
• 영문 제목: 'Complete Guide to React Hooks' → 'complete-guide-react-hooks' (불용어 제거 시)
• 영문 제목: 'Complete Guide to React Hooks' → 'complete-guide-to-react-hooks' (불용어 유지 시)

좋은 슬러그의 특징:

• 영문 소문자만 사용
• 하이픈(-)으로 단어 구분
• 특수문자 제거
• 간결하고 명확함
• 핵심 키워드 포함

슬러그 사용 예시:

• 깃허브: https://github.com/user/repo/blob/main/complete-guide-react-hooks.md
• 블로그: https://blog.example.com/posts/complete-guide-react-hooks
• 기술 문서: https://docs.example.com/guides/complete-guide-react-hooks

SEO 장점:

• 검색 엔진이 URL을 쉽게 이해함
• 키워드가 URL에 포함되어 SEO에 유리
• 사용자가 URL만 봐도 내용을 예상할 수 있음
• 소셜 미디어 공유 시 깔끔한 URL

팁:

• 슬러그는 가능한 짧게 (50자 이내 권장)
• 핵심 키워드를 앞부분에 배치
• 한글 제목은 자동으로 영문으로 변환되지만, 의미 전달이 부족할 수 있으니 필요시 수동 수정

작성한 마크다운을 HTML로 변환해야 하거나, 반대로 HTML을 마크다운으로 가져와야 할 때 변환 도구를 활용하면 작업 시간을 단축할 수 있습니다.

마크다운 → HTML 변환:

작업 순서:

• 마크다운 문서를 '마크다운 → HTML 변환' 도구에 붙여넣습니다
• 옵션을 선택합니다:
• - 줄바꿈에
  추가: 일반 줄바꿈을
  태그로 변환
• - 코드 블록을

  로 감싸기: 코드 블록을 HTML 형식으로

• 변환된 HTML을 복사하여 사용합니다

변환 예시:

# 제목
볼드 텍스트
[링크](https://example.com)

↓

제목
볼드 텍스트
링크

제목
본문 강조 텍스트

제목
본문 강조 텍스트