영역 세 개를 수직으로 분리하고 불필요한 정보도 없앴습니다.

소개문은 패키지 내 클래스로 무엇을 할 수 있는지 매우 짧은 요약을 제공합니다.

두 번째 부분은 패키지 내 주요 클래스로 무엇을 할 수 있는지 설명합니다. 패키지를 더 자세히 살펴보는 진입점이자 필요할 때 매우 훌륭한 아이디어도 제공합니다. @link 표기를 사용함으로써 간단히 클래스를 클릭해 바로 이동할 수도 있습니다. 심지어 JavaDoc 도구는 설명서를 생성하면서 연결된 클래스가 있는지도 확인합니다.

버전 관리 도구에도 들어 있는 정보인 @author와 같은 표기 대신 세 번째 부분에서는 주요 사용 사례(use case)를 어떻게 구현하는지 보여주는 구체적인 예제를 제공합니다. 개발자가 즉석에서 바로 사용할 수 있는 예제로요.

훌륭한 패키지 설명서는 이해도에 큰 변화를 불러옵니다. 패키지 내 모든 클래스로의 진입 장벽도 낮춥니다. 사용자 API가 훌륭히 문서화되고 깃허브에서 별도 더 많이 딸 수 있을 거예요!