Jupyter Notebook의 코드 품질, 문서화 수준, 실행 안정성을 표준화된 절차로 개선하는 워크플로우입니다.
기존 Jupyter Notebook을 **학습 자료 수준(Study Material Quality)**으로 다듬기 위한 워크플로우입니다. 단순 코드 정리(Linting)를 넘어, **"왜(Why)"**에 대한 설명과 재현 가능성(Reproducibility), 그리고 **시각적 이해(Visual Understanding)**를 확보하는 데 집중합니다.
this document를 읽어 'High Quality Notebook'의 기준을 로드합니다.resources/checklist.md와 대조하여 부족한 점을 파악합니다.
docs/notebooks/[Topic]_Analysis.ipynb 이름 규칙을 유지하며, 기존 파일을 덮어쓰거나 수정합니다.기능 변경 없이 코드의 가독성과 구조를 개선합니다.
df -> ), 셀의 단위를 적절히 나눕니다.titanic_df🔧 Setup & Imports)로 이동합니다."Master Class" 수준의 깊이를 더하기 위해 다음 요소들을 반드시 포함시킵니다.
코드를 체계적으로 정리하여 "책"처럼 읽히게 만듭니다.
#, ##)를 사용하여 목차를 구성합니다.To ensure Jupyter Notebooks are not just "functioning code dumps" but educational learning materials and reproducible assets.
A notebook is a document meant to be read by humans, not just a script for machines.
venv, python version).titanic_df) over generic ones (df). Follow conventions (X, y, model).fit() output)."Explain Why, Not What"
stratify=y to maintain class balance in the test set." (Insightful)#, ##) to navigate structure.