이 페이지에는 Google Season of Docs에 선정된 기술 문서 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- ARK 생태계
- 기술 문서 작성자:
- yslcrypto
- 프로젝트 이름:
- 프로젝트 1 - 핵심 블록체인 개발 시작 가이드
- 프로젝트 길이:
- 표준 기간 (3개월)
Project description
시작하기 섹션을 읽은 후 몇 가지 생각을 정리해 보았습니다.
개발 환경 설정 방법
설치: 여기에서 개발 도구를 설치하는 방법을 자세히 알아보겠습니다. 일반적인 오류와 해결 방법을 포함하여 코드 샘플을 제공하겠습니다 (여기에 문제 해결 페이지 링크를 제공할 수 있음).
첫 번째 테스트넷 시작: 첫인상: 현재는 살펴보기만 하고 빠르게 설정하려는 사용자에게는 매우 혼란스럽습니다. 다음과 같이 변경하고자 합니다.
테스트넷과 같은 기본 개념도 정의하는 것이 좋습니다.
mkdir, cd 등 더 짧은 코드 샘플을 더 많이 제공하고 독자가 더 쉽게 복사하여 붙여넣을 수 있도록 그룹화합니다. 너무 간단해서는 안 되며 누구나 복사하여 붙여넣기를 좋아합니다.
처음 읽을 때는 네트워크 부팅 하위 섹션의 1단계와 2단계가 무엇을 달성하는지 명확하지 않았습니다. 링크를 클릭하고 이동하는 데 너무 많은 생각을 해야 합니다. 이 부분을 복잡하게 만들지 않고 좀 더 명확하게 이해할 수 있을 것 같습니다.
적어도 5단계 (실제로는 4단계라고 생각함)에서 핵심 컨테이너를 대략적으로 설명하면 독자가 링크를 따라가지 않고도 자신이 어떤 작업을 하고 있는지 알 수 있습니다.
3단계와 5단계 (실제로 4단계)에서는 더 긴 코드 샘플을 설명합니다.
마지막 단계로, 독자의 편의를 위해 설치된 플러그인과 파일에 링크를 추가합니다.
마지막으로 한 문단에 아이디어가 하나만 있도록 수정합니다 (쉽게 훑어볼 수 있음). 또한 어조를 좀 더 재미있고 친근하게 바꾸고 이모티콘을 몇 개 추가하겠습니다.
블록체인을 모니터링하는 방법
첫 번째 단락을 간단히 작성하겠습니다. 플러그인이란 무엇인지, 대리인이 하는 역할 (또는 최소한 기본 원리 설명 링크), 블록 위조의 의미를 설명하고 네트워크 이벤트의 예를 제공합니다.
문제 정의: 읽는 사람에게 풀 노드가 무엇인지 직관적으로 설명하고, 더 자세한 설명으로 연결하고, 풀 노드와 외부 애플리케이션 간의 절충점을 더 잘 설명합니다. 마지막으로 이 하위 섹션의 끝에 이전 시작 페이지(작동하는 테스트넷 및 개발 환경을 설정하는 방법) 링크를 제공합니다(독자가 이 페이지를 먼저 발견한 경우).
Events API: 사용 가능한 이벤트 목록에서 원하는 결과를 얻기 위해 'block.applied'를 사용해야 하는지 명확하지 않습니다. 아래 도움말을 참고하시면 더 명확하게 이해하실 수 있습니다.
'block.applied'가 반환하는 값이 무엇인지 명확하지 않습니다. 이 점을 명확히 하는 것이 중요합니다.
끝에 있는 코드 예시에서 'block.generatorPublicKey'가 이전의 슈도코드 예시에서 'block.forger'를 대체하고 'delegateKey'가 'delegateWeAreMonitoring'을 대체한다는 점을 명확히 하는 것이 좋습니다. 마지막으로 코드와 슈도코드 샘플이 일관되도록 if 문에서 'delegateKey'와 'generatorKey'도 전환합니다.
플러그인 만들기: 이 맥락에서 스캐폴딩의 의미를 설명합니다. 예: 건설 현장의 실제 발판과 마찬가지로 이 맥락에서 발판이란 실제 발판을 빌드할 수 있는 간단한 사전 빌드된 플러그인 구조를 의미합니다.
코드 샘플을 추가하여 디렉터리와 플러그인의 이름을 바꾸고, package.json의 예를 보여주며, '필요한 구성을 추가'한다는 것이 어떤 의미인지 플러그인.js에 설명하겠습니다.
종합: 변경사항을 더 명확하게 설명하겠습니다. 축하하는 말과 몇 가지 이모티콘으로 마무리합니다. :)
ARK SDK를 사용하여 첫 번째 거래를 보내는 방법
시작하기: 사용자가 복사 붙여넣기로 새 디렉터리를 만들 수 있는 코드 샘플을 추가합니다.
Testnet에 연결: 읽는 사람이 REST API를 잘 모르는 경우 REST API의 정의를 설명하거나 최소한 설명 링크를 제공합니다. JSON 뷰어의 예시를 제공하고 링크를 제공해 드리겠습니다. 두 번째 도움말에서는 독자에게 부탁을 드리므로 더 친근한 어조를 사용합니다.
구성 관리자 변경: 네트워크 관련 버그의 일반적인 예를 언급하고 문제 해결 섹션으로 연결하는 것이 좋습니다.
발신 및 수신 계정 설정: 읽는 사람이 복사 붙여넣기로 구성 디렉터리로 변경할 수 있는 코드 샘플을 추가합니다. delegates.json의 콘텐츠를 보여주는 코드 샘플을 추가하겠습니다.
ARK CORE TESTER CLI를 사용하여 거래를 전송하는 방법
기본 요건: ARK Core GitHub 저장소의 작동되는 사본을 가져오는 방법과 리더를 올바른 디렉터리로 이동하는 코드를 가져오는 코드 샘플을 추가합니다.
기본사항: 경로 환경 변수에 익숙하지 않은 사용자를 위해 첫 번째 단락을 더 명확하게 설명하겠습니다.
결론
끝으로, 문서를 읽으면서 간단히 메모한 내용을 전해 드립니다. 프로젝트를 함께 시작할 때는 제가 직접 절차를 진행해 어떤 문제가 있는지 확인하고 싶습니다. 그리고 이 지식을 사용하여 문서를 더욱 단순화합니다.
마지막으로, 지금까지 한 프로젝트만 완료했지만, 2주도 채 걸리지 않습니다. 이메일로 말씀드린 대로 함께하는 동안 여러 프로젝트를 진행할 수 있을 것 같습니다.