KANT-AX-AI-Engineer

이 레포에서 작업할 때

KANT AX/AI 엔지니어 트랙 수강생에게 공유하는 학습 자료 레포예요. 수강생은 나이와 배경이 다양하고, 대부분 개발이 처음이에요.

자료는 배우는 순서대로 01-주제, 02-주제처럼 두 자리 번호와 영문 소문자 이름으로 만들어요. (예: 01-linux-terminal, 02-git-basics, 03-git-branch)
폴더마다 수강생이 읽을 README.md를 둬요. 무엇을 배우는지, 어떤 순서로 보면 되는지, 꼭 기억할 명령을 적어요.
슬라이드가 있는 폴더에는 수강생이 바로 받을 HTML(주제-slides.html, 애니메이션 포함)과 PDF(주제-slides.pdf)를 같이 둬요. 슬라이드를 고치면 둘 다 다시 만들어요. 만드는 스크립트는 02-git-basics/tools/의 build_player.js, export.js예요.
강사용 도구(생성·검사·PDF 내보내기 스크립트)는 해당 폴더의 tools/에 둬요.
레포 맨 위 README.md의 목차에 새 폴더와 HTML 링크를 추가해요. HTML은 GitHub Pages 주소(https://woogi-kang.github.io/KANT-AX-AI-Engineer/폴더/파일.html)로 걸어요. README에는 PDF 다운로드 링크를 넣지 않아요(PDF 파일은 강사용으로 계속 만들어 둬요).

git push -u, --set-upstream, push.autoSetupRemote는 쓰지 않아요. push와 pull은 항상 git push origin main, git pull origin main처럼 끝까지 적어요.
GitHub과 비교할 땐 git fetch origin 뒤 git log --oneline과 git log --oneline origin/main을 봐요.
git log에 --graph, --all 옵션은 쓰지 않아요. 자료, README, 슬라이드 모두 같아요.
git restore는 아직 배우지 않았으니 자료에 넣지 않아요.
커밋 메시지는 Conventional Commits 형식(feat:, fix:, docs: …)으로 써요. 이 레포에 커밋할 때도 같아요.
터미널 출력은 실제 git으로 실행해 보고 그대로 옮겨요. 지어낸 출력은 넣지 않아요.

자료, README, 커밋 메시지, 발표자 노트 등 이 레포에 들어가는 한국어는 모두 이 기준으로 써요. 다 쓴 뒤 아래 목록으로 한 번 더 훑어서 고쳐요.

말투

수강생에게 말하듯 해요체로 통일해요. 한 문서 안에서 “~합니다”와 “~해요”를 섞지 않아요. (README 표나 목록의 짧은 항목은 명사형으로 끝내도 돼요.)
한 문장에는 한 가지만 말해요. 쉼표로 세 개 이상 이어 붙이면 문장을 나눠요.
주어가 뻔하면 생략해요. “여러분은”, “우리는”, “사용자는”을 문장마다 붙이지 않아요.

번역투와 AI 티 나는 표현 고치기

모양

긴 대시(—)와 화살표 연쇄(A → B → C → D)로 문장을 잇지 않아요. 순서는 번호 목록으로 써요. (명령 흐름을 보여 주는 짧은 표기 add → commit은 괜찮아요.)
굵은 글씨는 한 단락에 한 번까지만 써요.
이모지와 느낌표는 쓰지 않아요. 경고가 필요하면 무엇이 왜 위험한지 한 줄로 적어요.
영어 용어는 처음 나올 때 한 번만 풀어 쓰고(예: 스테이징 영역(대기실)), 그 뒤로는 같은 말을 계속 써요.
같은 내용을 제목, 본문, 요약에서 반복하지 않아요.

마지막 점검