이 페이지는 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 옵션에 대한 기본적인 요약을 제공합니다.
기본 개요: 이 섹션에서는 다양한 사용 사례 시나리오와 이러한 시나리오에서 권장되는 옵션을 제공합니다.
참고: 이 부분은 Scancode-Toolkit의 다양한 사용 사례에 대한 입력과 포인터 측면에서 멘토의 상당한 도움이 필요합니다.

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

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

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

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

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

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

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

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

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

이 부분에는 Aboutcode 문서의 여러 변경사항이 포함되어 있습니다.

[ 1. 버전 관리 시스템 ]

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

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

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

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

이 섹션은 초보자를 위한 시작 섹션이며 Aboutcode 프로젝트 시작하기에 필요한 가장 기본적이고 중요한 문서 모음이 포함되어 있습니다. 모든 Aboutcode 프로젝트에는 Scancode-Toolkit, Scancode-Workbench, Deltacode 등이 포함된 이 섹션이 있습니다.

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

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

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

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

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

이 하위 섹션에는 그런 다음 아래 하위 섹션에 해당 부분에 대한 자세한 정보/API가 포함되어 있습니다. 개발 가이드라인은 다른 페이지나 더 작은 하위 섹션이 있는 다른 섹션에 있습니다.

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

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

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