폴리글롯 Notebook 소개
시스템을 문서화하는 것은 효율적으로 작업하는 데 중요합니다. 그러나 특정 API 설명서부터 시스템을 설명하는 서면 설명서, UML(Unified Modeling Language)까지 문서화하는 방법은 다양하며, 테스트도 설명서의 일부로 간주할 수 있습니다. 시스템이 변화하므로 설명서도 함께 변화해야 합니다. 유용한 설명서에는 시스템의 다양한 부분을 사용하는 방법을 보여 주는 코드도 포함되어야 합니다.
시나리오: 개발 팀을 위한 살아있는 설명서 작성
개발 팀의 일원으로서 백 엔드에서 프런트 엔드, 심지어 모바일 앱 프로젝트까지 다양한 코드베이스를 빌드하고 유지 관리합니다. 버그를 해결하거나 새로운 기능을 빌드하기 위해 프로젝트를 전환하는 경우가 많습니다. 더 쉽게 온보딩하고 컨텍스트를 전환하기 위해 시스템을 문서화하여 유지 관리가 더 쉬워지는 방법을 찾으려고 합니다.
이 모듈을 완료한 후에는 다음을 수행할 수 있습니다.
- 폴리글롯 Notebooks를 사용해야 하는 이유를 설명합니다.
- Notebooks를 만들고 실행합니다.
- 변수 공유 및 명령과 같은 기능을 사용하여 프런트 엔드와 백 엔드 및 Mermaid를 결합하여 순서도와 다이어그램을 렌더링합니다.
학습 목표
이 모듈을 완료하면 정적 텍스트뿐만 아니라 살아있는 설명서를 만들기 위해 실행할 수 있는 코드를 사용하여 IT 시스템을 문서화하는 방법을 배웁니다.
필수 조건
폴리글롯 Notebooks를 시작하려면 다음이 필요합니다.
- 최신 .NET SDK를 설치합니다.
- Visual Studio Code에서 폴리글롯 Notebook을 확장으로 설치합니다. 여기에서 Notebooks를 만들기 및 실행하고 더 많은 작업을 수행할 수 있습니다.