Documentation

문서화

9개 레벨

소프트웨어 개발 과정에서 요구사항, 설계, 테스트 등을 기록하는 문서에요. 이는 팀원 간의 커뮤니케이션을 돕고, 유지보수 및 발전에 중요해요. 정확한 문서화는 프로젝트의 성공에 기여해요.

문서화 스킬 여정을 시작하세요

9개의 레벨을 통해 체계적으로 학습하고, 커리어 성장의 기반을 다지세요.

9 레벨 로드맵

단계별 역량 인증

학습 로드맵

9개 레벨

전체 9

Lv 1. 기술 문서의 목적과 기본 구조를 알아요

1. 기술 문서 개요
2. 대상 독자 분석
3. 문서 구조 설계

연습 문제

1.
간단한 주제에 대해 목표 독자와 목차를 설계해요
2.
웹 서비스 예시 문서의 목차와 구성을 분석해요

Lv 2. Markdown을 이용해 기본적인 문서를 작성할 수 있어요

Lv 3. Markdown으로 코드 블록, 링크, 이미지를 삽입할 수 있어요

Lv 4. MkDocs를 설치하고 기본 문서 사이트를 구성할 수 있어요

로그인하고 더 많은 레벨을 확인하세요

Lv 5. MkDocs 테마를 커스터마이징할 수 있어요

Lv 6. GitHub Pages와 Actions를 이용해 문서를 자동으로 배포할 수 있어요

Lv 7. 팀과 협업하며 문서를 관리하고 리뷰할 수 있어요

Lv 8. 코드 주석을 기반으로 API 문서를 자동 생성할 수 있어요

Lv 9. 다국어 지원과 버전 관리를 통해 대규모 프로젝트 문서를 운영할 수 있어요

이 스킬로 지원할 수 있는 채용공고