이 페이지는 Cloud Translation API를 통해 번역되었습니다.

AboutCode 프로젝트

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

프로젝트 요약

오픈소스 조직:: AboutCode
테크니컬 라이터:: 아얀시냐
프로젝트 이름:: scancode- Toolkit의 명령줄 옵션 참조 및 aboutcode.readthedocs.io에 있는 AboutCode 문서의 구조 재구성
프로젝트 기간:: 표준 기간 (3개월)

Project description

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

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

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

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

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

목표: 버전 관리 시스템을 시작하여 출시 간 옵션/API 및 문서 변경사항을 적절히 유지합니다.
문제: 현재 위키와 ReadTheDocs 페이지의 문서는 이전 출시 버전이므로 대대적인 구조 조정이 필요합니다.
기본 개요: 스캔 코드 툴킷에서 업데이트되었거나 업데이트될 수 있는 부분은 다음과 같습니다.
명령줄 옵션
API
문서 (시작 예정) 명령줄 옵션과 API는 버전과 버전에서 변경되며 문서도 따라야 합니다. 그러지 않으면 사용자에게 엄청난 혼란을 야기할 수 있습니다. 명령줄 유틸리티[ --help ] 는 옵션 변경에 따라 이미 업데이트되었으며, 설명서에서 버전 관리를 복제하는 데 사용할 수 있습니다.

[ 3. 사례별로 사용 가능한 옵션 ]

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

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

목표: 이 섹션에서는 다양한 원인에서 스캔 코드 툴킷의 스캔 결과를 어떻게 사용할 수 있는지에 대한 기본적인 요약과 이러한 기능을 제공하는 Aboutcode 도구를 제공합니다.
기본 개요: 이 옵션은 검사 수행 방식의 동작을 변경합니다. 기본적인 기본 사례는 선행 섹션 [ 1. 명령줄을 통해 사용할 수 있는 모든 옵션 ] 과 이 섹션에서는 모든 옵션이 기본 시나리오에 미치는 변경사항을 비교합니다.

[ 5. 화면출력 형식 및 예 ]

목표: 이 섹션에서는 다양한 원인에서 스캔 코드 툴킷의 스캔 결과를 어떻게 사용할 수 있는지에 대한 기본적인 요약과 이러한 기능을 제공하는 Aboutcode 도구를 제공합니다.
기본 개요: Scancode-Tool에는 스캔 결과를 생성할 다양한 출력 형식을 지정하는 플래그가 있습니다. 말씀하신 내용은 다음과 같습니다.
이 부분은
출력 형식을 자세히 설명하고
출력 형식에 대한 예를 제공합니다.
출력 형식 및 용도에 해당하는 다른 링크를 제공합니다.
스캔 결과가 출력 파일에 저장되는 방식 또한 다양한 형식이 생성되는 방식에 대한 페이지로 연결됩니다. 이에 대해서는 [ 2. 코드 스캔을 설명하는 토론 ]

[ 6. 스캔 코드 출력 형식의 비즈니스 사용 ]

목표: 스캔 코드 출력 형식의 비즈니스 사용 사례 설명 GSoD 아이디어 목록에서 스캔 코드 출력 형식이 참조 아이디어로 언급되어 있습니다. 이 섹션에서도 동일하게 구현합니다.
참고: 이 부분에서는 스캔 코드 툴킷의 다양한 비즈니스 사용 사례에 대한 입력 및 포인터와 관련하여 멘토의 상당한 도움이 필요합니다.

[ 7. 다른 AboutCode 프로젝트에서 더 많은 분석을 위해 이러한 출력을 사용하는 방법 ]

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

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

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

[ 1. 버전 관리 시스템 ]

[ 1. 스캔 코드-툴킷 명령줄 옵션 -> 2. 버전 관리 구조 시작] 명령줄 옵션의 버전 관리 문제가 언급되었습니다. 버전별 명령/정보가 들어 있으면 혼동을 야기할 수 있는 문서의 다른 부분에도 마찬가지가 필요합니다.

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

이 문서에는 이미 Travis-CI를 통한 지속적 통합과 함께 Sphinx-build 테스트 (모든 페이지를 빌드하고 전체 Sphinx 구문 오류 확인) 및 링크 검사 (문서에서 다른 웹페이지로 연결되는 모든 링크 확인)가 테스트되었습니다. (이 pull 요청 #17에 내가 추가함) 이제 재구성 텍스트 및 기타 표준의 특정 린트 작업에 대한 추가 검사가 필요합니다. 이는 re구조화된text-lint를 사용하여 달성할 수 있지만, 더 많은 연구가 필요하고 GSoD 프로젝트의 일부로 수행될 것입니다.

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

이 섹션은 초보자를 위한 시작 섹션으로 사용되며, Aboutcode Projects를 시작하는 데 필요한 가장 기본적이고 중요한 문서의 컴파일을 포함합니다. Scancode-Toolkit, Scancode-Workbench, Deltacode 등을 포함한 모든 Aboutcode 프로젝트에는 이 섹션이 있습니다.

[ 4. 4가지 문서 함수에 따른 재구성 ]

기존 문서는 4가지 문서 기능(튜토리얼, 방법, 참조, 설명)으로 명확하게 구성되어 있지 않습니다. 따라서 필요에 따라 더 많은 정보/설명/포인터를 추가하여 이를 적절히 구성하는 것이 좋습니다. 이는 모든 AboutCode 프로젝트 및 관련 문서에 적용됩니다. 다음은 제가 제안한 Scancode-Toolkit 문서 재구성의 두 가지 예이며 이 프로젝트에서 계속 진행하려고 합니다. 나머지 문서에서도 유사한 변경사항이 적용됩니다.

[ 5. 개발 페이지 재구성 (스캔 코드 툴킷) ]

개발자 친화적으로 만들기 위해 코드/API에 관한 정보를 더 추가할 수 있습니다. [ 2. 위의 코드 스캔 ] 섹션을 설명하는 토론. 이렇게 하면 스캔 작동 방식에 대한 설명이 스캔을 수행하는 데 사용되는 코드와 연결됩니다. 이러한 폴더에는 스캔 코드 툴킷의 다른 부분이 포함되어 있는 것처럼, 스캔 코드 작동 방식에 대한 논의와 함께 API를 사용하여 개별 용도를 자세히 설명할 수 있습니다.

[ Commoncode : 도우미 클래스 및 함수]
[ extractcode : 다양한 보관 파일 형식 추출 ]
[ formattedcode : 여러 출력 파일 형식의 출력 형식 지정 ]
[ 라이선스 코드 : 라이선스 감지 코드 ]
[ packagedcode : 다양한 패키지 형식 파싱 ]
[ plugincode : 플러그인 아키텍처용 클래스 ]
[ summarycode : 탐지된 라이선스에 대한 스캔 요약 ]
[ textcode : 텍스트 파싱 처리 ]
[ typecode : 파일 형식 결정 처리 ]
[ 스캔 코드 : 스캔 코드를 위한 CLI 및 API, 핵심 부분 ]

이 하위 섹션에는 그에 따라 하위 하위 섹션에 이 같은 부분의 스캔 코드 툴킷에 관한 자세한 정보/API가 포함됩니다. 개발 가이드라인은 다른 페이지나 다른 섹션에 더 작은 하위 섹션이 있습니다.

[ 6. FAQ 페이지 재구성 (스캔 코드 툴킷) ]

현재 FAQ 페이지에는 더 나은 답변을 제공할 수 있는 질문이 있으며 사용 방법, 튜토리얼, 참조 문서로 각각 구성되어 있습니다.

ScanCode는 어떻게 작동하나요? 이 문제는 [ 2. 코드 스캔 ] 에 대해 설명하는 토론이며, 훨씬 더 자세한 내용을 다루는 완전히 별도의 섹션에서 진행됩니다.
향상된 감지를 위해 새 라이선스 규칙을 추가하는 방법 이 문제는 '기존 방법 개선' 섹션에서 이미 논의한 바와 같이 문서가 이곳으로 이동됩니다.
새 라이선스 감지 규칙을 추가하는 방법 이 내용은 별도의 '방법' 게시물로 만들 수 있으며 자세히 다룰 수 있습니다.
개발을 시작하는 방법 이미 별도의 개발 페이지가 있고 정보가 상당히 중복됩니다. 개발 페이지의 재구성은 위에서 이미 설명했습니다.
새 버전을 편집하는 단계 이는 별도의 '새 버전을 자르는 방법'으로 변환할 수 있습니다.
프로젝트에 대한 일반적인 질문에 답하고 '방법'/'튜토리얼' 카테고리에 포함되지 않는 더 많은 FAQ 질문을 찾아보세요.