AboutCode 프로젝트

이 페이지에는 Google Season of Docs에 참여하기로 한 기술 문서 작성 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:

AboutCode

기술 문서 작성자:

ayansinha

프로젝트 이름:

scancode-toolkit의 명령줄 옵션 참조 및 aboutcode.readthedocs.io에서 AboutCode 문서의 구조 재구성

프로젝트 기간:

표준 기간 (3개월)

프로젝트 설명

[ 1. Scancode-Toolkit 명령줄 옵션 ]

Scancode-Toolkit에는 스캔 실행 방식, 출력 형식, 스캔 후 플러그인과 같은 여러 기타 옵션을 맞춤설정하는 데 사용할 수 있는 다양한 명령줄 옵션이 있습니다. 이러한 옵션은 현재 이를 설명하는 적절한 문서가 없으며 '--help' 또는 '-h' 플래그를 통해서만 사용할 수 있습니다. 이 프로젝트는 다음을 설명하는 완전한 문서를 만드는 것을 목표로 합니다.

[ 1. 명령줄을 통해 사용할 수 있는 모든 옵션 ]

• 목표: 명령줄을 통해 사용할 수 있는 모든 옵션의 전체 목록입니다.
• 기본 개요: 먼저 출력 예시와 함께 기본 스캔 옵션이 설명됩니다. 스캔 실행 방법에 관한 간단한 그래픽/설명입니다.
  이후 이 기본 동작은 다른 옵션이 스캔과 출력을 변경하는 방식을 참조하는 역할을 합니다.
  이러한 내용은 자세히 설명되며 다음 섹션에 언급된 정보가 포함됩니다.

[ 2. 버전 관리 구조 시작 ]

• 목표: 교차 출시 옵션/API 및 문서 변경사항을 적절하게 유지관리하기 위한 버전 관리 시스템을 시작합니다.
• 문제: 현재 위키 및 ReadTheDocs 페이지의 문서는 이전 출시 버전을 위한 것이며 대대적인 재구성이 필요합니다.
• 기본 개요: 버전에서 업데이트되었거나 업데이트될 수 있는 scancode-toolkit의 부분은 다음과 같습니다.
• 명령줄 옵션
• API
• 문서 (시작 예정) 명령줄 옵션과 API는 버전 및 출시에서 변경되며 문서도 이를 따라야 합니다. 그렇지 않으면 사용자에게 큰 혼란을 야기할 수 있습니다. 명령줄 유틸리티 [--help ] 는 이미 옵션의 변경사항에 맞게 업데이트되었으며 문서에서 버전 관리를 복제하는 데 사용할 수 있습니다.

[ 3. 다양한 경우에 이러한 옵션을 사용하는 방법 ]

• 목표: 이 섹션에서는 scancode-toolkit의 스캔 결과를 다양한 원인에 사용할 수 있는 방법과 이러한 기능을 제공하는 Scancode-Toolkit 옵션에 관한 기본 요약을 제공합니다.
• 기본 개요: 이 섹션에서는 다양한 사용 사례 시나리오 예시와 이러한 시나리오에서 권장되는 옵션을 제공합니다.
• 참고: 이 부분에서는 Scancode-Toolkit의 다양한 사용 사례에 관한 입력 및 포인터 측면에서 멘토의 상당한 도움이 필요합니다.

[ 4. 이러한 옵션이 스캔 및 출력에서 변경하는 사항 ]

• 목표: 이 섹션에서는 scancode-toolkit의 스캔 결과를 다양한 원인에 사용할 수 있는 방법과 이러한 기능을 제공하는 Aboutcode 도구에 관한 기본 요약을 제공합니다.
• 기본 개요: 옵션은 스캔 실행 방식의 동작을 변경합니다. 기본 기본 사례는 선행 섹션 [ 1. 명령줄을 통해 사용할 수 있는 모든 옵션 ] 에 설명되며 이 섹션에서는 모든 옵션이 이 기본 시나리오에 가져오는 변경사항을 비교합니다.

[ 5. 출력 형식 및 예시 ]

• 목표: 이 섹션에서는 scancode-toolkit의 스캔 결과를 다양한 원인에 사용할 수 있는 방법과 이러한 기능을 제공하는 Aboutcode 도구에 관한 기본 요약을 제공합니다.
• 기본 개요: Scancode-Tool에는 스캔 결과가 생성될 다양한 출력 형식을 지정하는 플래그가 있습니다. 다음은 -
  이 부분에서는
• 출력 형식을 자세히 설명합니다.
• 출력 형식에 관한 예시를 제공합니다.
• 출력 형식 및 사용에 해당하는 기타 링크를 제공합니다.
• 스캔 결과가 출력 파일에 저장되는 방식입니다. 또한 [ 2. 코드 스캔 설명 ]에서 설명될 이러한 다양한 형식이 생성되는 방식에 연결됩니다.

[ 6. Scancode 출력 형식의 비즈니스 사용 ]

• 목표: Scancode 출력 형식의 비즈니스 사용 사례 설명 GSoD 아이디어 목록에서 Scancode 출력 형식이 참조 아이디어로 언급됩니다. 이 섹션에서는 이를 구현합니다.
• 참고: 이 부분에서는 Scancode-Toolkit의 다양한 비즈니스 사용 사례에 관한 입력 및 포인터 측면에서 멘토의 상당한 도움이 필요합니다.

[ 7. 이러한 출력이 추가 분석을 위해 다른 AboutCode 프로젝트에서 사용되는 방식 ]

• 목표: 이 섹션에서는 scancode-toolkit의 스캔 결과를 다양한 원인에 사용할 수 있는 방법과 이러한 기능을 제공하는 Aboutcode 도구에 관한 기본 요약을 제공합니다.
• 기본 개요:
• Scancode-Workbench 이 부분에서는 데스크톱 앱으로 결과를 시각화하는 방법과 이에 관한 추가 지원을 위한 scancode-workbench 문서 포인터를 설명합니다. 필요한 경우 scancode-workbench에 필요한 문서를 추가합니다.
• Deltacode Deltacode에서 scancode 결과를 가져와 두 코드베이스 간의 파일 수준 차이를 확인하는 방법입니다.

[ 2. AboutCode 문서의 구조 재구성 ]

이 부분에는 Aboutcode 문서에 관한 다양한 변경사항이 포함되어 있습니다.

[ 1. 버전 관리 시스템 ]

[ 1. Scancode-Toolkit 명령줄 옵션 -> 2. 버전 관리 구조 시작] 에서 명령줄 옵션의 버전 관리 문제가 언급됩니다. 버전별 명령어/정보가 포함되어 있어 혼란을 야기할 수 있는 문서의 다른 부분에도 동일한 내용이 필요합니다.

[ 2. 문서 표준 및 테스트 설정 ]

문서에는 이미 Travis-CI를 통한 지속적 통합으로 spinx-build (모든 페이지를 빌드하고 전체에서 Sphinx 구문 오류를 확인함) 및 링크 확인 (문서에서 다른 웹페이지로 연결되는 모든 링크를 확인함)에 관한 테스트가 있습니다. (이 Pull Request #17에서 내가 추가함) 이제 reStructured Text 및 기타 표준에서 특정 린팅에 관한 추가 검사가 필요합니다. 이는 restructuredtext-lint를 통해 달성할 수 있지만 추가 연구가 필요하며 GSoD 프로젝트의 일부로 진행됩니다.

[ 3. '시작하기' 섹션 추가 ]

이는 신규 사용자를 위한 시작 섹션 역할을 하며 Aboutcode 프로젝트를 시작하는 데 필요한 가장 기본적인 중요 문서의 모음이 포함됩니다. 모든 Aboutcode 프로젝트에는 Scancode-Toolkit, Scancode-Workbench, Deltacode 등을 포함하여 이 섹션이 있습니다.

[ 4. 4가지 문서 기능에 따라 재구성 ]

기존 문서는 4가지 문서 기능(튜토리얼, 방법, 참조, 설명)으로 명시적으로 구조화되어 있지 않습니다. 이에 따라 필요한 정보/설명/포인터를 추가하여 구조화할 것을 제안합니다. 이는 모든 AboutCode 프로젝트와 해당 문서에 적용됩니다. 아래는 이 프로젝트에서 제안하고 진행하고자 하는 Scancode-Toolkit 문서 재구성의 두 가지 예시입니다. 나머지 문서에도 비슷한 변경사항이 적용됩니다.

[ 5. 개발 페이지 재구성 (Scancode-Toolkit) ]

코드/API에 관한 추가 정보를 추가하여 개발자 친화적으로 만들 수 있습니다. 위의 [ 2. 코드 스캔 설명 ] 섹션으로 연결되는 링크가 있을 수 있습니다. 이렇게 하면 스캔 작동 방식에 관한 설명이 스캔을 실행하는 데 사용하는 코드에 연결됩니다. 이러한 폴더에는 scancode-toolkit의 여러 부분이 포함되어 있으며 scancode 작동 방식에 관한 논의와 함께 API를 사용하여 개별 사용을 자세히 설명할 수 있습니다.

• [ cluecode : 라이선스, 저작권, URL, 이메일 스캔을 위한 플러그인 ]
• [ commoncode : 도우미 클래스 및 함수]
• [ extractcode : 다양한 보관 파일 형식 추출 ]
• [ formattedcode : 다양한 출력 파일 형식의 출력 형식 지정 ]
• [ licensedcode : 라이선스 감지 코드 ]
• [ packagedcode : 다양한 패키지 형식 파싱 ]
• [ plugincode : 플러그인 아키텍처의 클래스 ]
• [ summarycode : 감지된 라이선스에 관한 스캔 요약 ]
• [ textcode : 텍스트 파싱 처리 ]
• [ typecode : 파일 형식 결정 처리 ]
• [ scancode : scancode의 핵심 부분인 scancode의 CLI 및 API ]

이 하위 섹션에는 scancode-toolkit의 이러한 부분에 관한 자세한 정보/API가 하위 하위 섹션에 포함됩니다. 개발 가이드라인은 더 작은 하위 섹션이 있는 다른 페이지 또는 다른 섹션에 있습니다.

[ 6. FAQ 페이지 재구성 (Scancode-Toolkit) ]

현재 FAQ 페이지에는 더 나은 답변을 제공할 수 있는 질문이 있으며 별도의 방법, 튜토리얼, 참조 문서로 구조화되어야 합니다.

• ScanCode는 어떻게 작동하나요? 이 문제는 [ 2. 코드 스캔 설명 ] 에서 참조되며 훨씬 더 자세한 완전히 별도의 섹션이 됩니다.
• 감지 기능을 개선하기 위해 새 라이선스 규칙을 추가하는 방법은 무엇인가요? 이 문제는 기존 방법 개선에서 이미 논의되었으며 문서는 그곳으로 이동됩니다.
• 새 라이선스 감지 규칙을 추가하는 방법은 무엇인가요? 이는 별도의 '방법' 게시물로 만들고 자세히 설명할 수 있습니다.
• 개발을 시작하는 방법은 무엇인가요? 이미 별도의 개발 페이지가 있으며 정보가 상당히 많이 겹칩니다. 개발 페이지의 재구성은 이미 위에서 논의되었습니다.
• 새 출시 버전을 컷하는 단계 이는 별도의 '새 출시 버전 컷하는 방법'으로 변환할 수 있습니다.
• 프로젝트에 관한 일반적인 질문에 답변하고 '방법'/'튜토리얼' 카테고리에 속하지 않는 FAQ 질문을 더 찾아보세요.