이득:
- 백서 작성, NatSpec, 기술적 단순 번역 및 위험 공개에 인공지능을 안전하게 사용할 수 있고 이것이 가장 생산적인 분야임을 이해합니다.
- 실제 코드로 각 기술적 주장을 검증하고 과장 및 보증 언어를 제거하여 잘못된 문서화의 위험을 방지하는 기능
- 위험을 정직하게 수용하는 능력, '재무 조언 아님' 경고 및 문서 코드 일관성
Web3의 문서화는 사치가 아니라 보안과 신뢰의 문제입니다. 스마트 계약과 상호 작용함으로써 사용자는 실제 돈을 위험에 빠뜨립니다. 자신이 하고 있는 일을 이해하지 못한다면 그는 속임을 당할 가능성이 높습니다. 감사자는 잘 문서화되지 않은 코드를 안전하게 검토할 수 없습니다. 이 단원에서는 AI가 가장 안정적이고 효율적인 영역인 문서화 및 기술 문서 작성을 다룹니다. 백서에서 코드 내 주석, 사용자 가이드에서 위험 공개에 이르기까지 AI는 정확성이 인도적으로 모니터링되는 한 실질적인 힘의 승수입니다.
Web3 문서의 유형
- 백서/라이트페이퍼: 프로젝트의 비전, 메커니즘 및 토큰경제학을 설명하는 기본 문서입니다.
- 기술 문서: 계약 인터페이스, 개발자를 위한 통합 가이드.
- NatSpec(Ethereum Natural Language 사양 — 함수의 기능을 설명하는 Solidity의 표준 코드 내 주석 형식): 코드에 포함된 문서로 사람과 도구 모두가 읽을 수 있습니다.
- 사용자 가이드: 최종 사용자에게 "사용 방법, 어떤 위험이 있는지"를 알려주는 일반 텍스트입니다.
- 면책조항: 법적, 윤리적으로 요구되는 경고입니다.
이러한 유형의 일반적인 문제는 개발자가 글쓰기를 좋아하지 않고 종종 마지막 순간까지 남겨두는 것입니다. AI는 바로 이 격차를 메워줍니다.
문서화가 AI의 가장 안전한 영역인 이유
문서 오류로 인한 비용은 감사보다 낮습니다. 잘못된 문장 하나가 수정되면 돈이 (직접) 날아가지 않습니다. 게다가 AI는 자연스럽게 언어 생산에도 강합니다. 따라서 AI는 여기서 효율적이고 상대적으로 안전합니다. 그러나 두 가지 중요한 위험이 남아 있습니다.
- 잘못된 기술 주장: AI는 코드의 기능을 잘못 표현할 수 있습니다. 이는 사용자를 오도하고 보안 취약점이 될 수 있습니다("이 기능은 귀하의 자금을 보호합니다"라고 말하고 그렇지 않은 경우 제외).
- 과장법/마케팅 언어: AI는 프로젝트가 안전하거나 수익성이 있는 것처럼 보이게 만드는 언어를 생성할 수 있습니다. 이는 윤리적 문제이자 법적 문제입니다.
주의: 문서에는 코드가 설명되어 있습니다. 코드 자체가 아닙니다. AI가 작성하는 모든 기술적 주장("이런 일이 발생합니다", "유지하는")은 실제 코드에 대해 검증되어야 합니다. 사용자가 문서를 신뢰하기 때문에 잘못된 문서는 올바른 코드보다 더 위험할 수 있습니다.
문서에서 AI를 사용하는 계층
1. NatSpec 생성. AI는 기존 함수를 읽고 NatSpec 해석의 초안을 작성합니다. 즉, 함수가 수행하는 작업, 매개변수는 무엇인지, 반환하는 내용은 무엇입니까? 이는 검사 및 유지보수를 단순화합니다.
2. 기술적인 단순 번역. AI는 복잡한 메커니즘을 최종 사용자가 이해할 수 있는 언어로 변환합니다. 이는 Web3의 가장 큰 요구 사항 중 하나입니다.
3. 백서 개요 및 구조. AI는 백서의 뼈대와 섹션을 생성합니다. 내용의 정확성은 인간의 것입니다.
4. 다국어 사용 및 레벨 조정. AI는 기술적인 콘텐츠와 일반 콘텐츠 모두 터키어와 영어로 동일한 콘텐츠를 생성할 수 있습니다.
약한 프롬프트 / 강한 프롬프트
약한 프롬프트:
이 프로젝트에 대한 백서를 작성하세요.
AI는 실제 메커니즘을 알지 못한 채 과장되고 허위일 수 있으며 마케팅이 가득한 카피를 만들어냅니다.
강력한 프롬프트:
귀하의 역할: Web3 기술 작가. 다음은 프로젝트의 실제 메커니즘, 토큰경제학 및 코드입니다. 이 정보만을 토대로 백서 초안을 작성하십시오. 규칙: - 과장하지 마십시오. "이익 보장", "완전히 안전함" 등과 같은 문구를 사용하지 마십시오. - 각 기술 주장은 제가 제공하는 메커니즘을 기반으로 합니다. 조작을 추가하지 마십시오.- 위험을 명확하게 설명하는 "위험"섹션을 추가하십시오.- "이것은 재정적 조언이 아닙니다."라는 경고를 추가하십시오. 확실하지 않거나 제가 갖고 있지 않은 정보는 [입력 예정]으로 표시하세요.
복사 가능한 템플릿 4개
1) NatSpec 생성:
다음 함수에 표준 NatSpec 주석을 작성합니다: @notice(무엇을 하는지, 일반), @dev(기술 참고 사항), @param 및 @return. 코드가 실제로 수행하는 작업만 작성하세요. 코드에 없는 동작을 추가합니다. 확실하지 않은 효과에 플래그를 지정하세요.
2) 기술적인 단순 번역:
암호화폐 초보자 사용자가 이해할 수 있도록 이 메커니즘을 일반 터키어로 설명합니다. 이 메커니즘은 무엇을 수행하고, 사용자는 무엇을 해야 하며, 어떤 위험이 있습니까? 과장; 보안이 보장되지 않습니다. 위험을 숨기지 말고 전면에 내세우십시오.
3) 위험/경고 섹션:
이 프로젝트에 대한 정직한 "위험 및 주의 사항" 섹션을 작성하십시오: 스마트 계약 위험, 시장 위험, 유동성 위험, 규제 불확실성, 키 손실. 각 위험을 쉬운 언어로 설명하세요. 위험을 과소평가하지 마십시오. "이것은 재정적 조언이 아닙니다."로 끝납니다.
4) 문서 코드 일관성 확인:
다음은 함수와 사용 가능한 문서입니다. 문서가 코드의 실제 동작과 모순되거나 생략된 부분을 표시하세요. 최종 의사결정 "개발자 확인"을 위해 제출하세요.
미니 케이스 3개(숫자 기준)
사례 1 - NatSpec이 검사를 강화했습니다. 한 팀은 의견 없이 검토를 위해 25개 기능 계약을 제출했습니다. 감사자는 논리를 이해하기 위해 추가 시간을 요청했습니다. 팀은 AI로 NatSpec 초안을 생성하고 코드로 각각을 확인했습니다. 감사 준비가 거의 1일 단축되었습니다. 교훈: 좋은 문서화는 감사 비용을 줄여줍니다.
사례 2 - 허위 주장이 적발되었습니다. YZ가 제작한 사용자 매뉴얼에는 "귀하의 자금은 언제든지 인출될 수 있습니다"라고 명시되어 있습니다. 계약에는 7일 잠금이 있었습니다. 기술 검토에서 이를 발견했습니다. 만약 그것이 출판된다면, 사용자들은 오해를 받고 피해를 입을 것입니다. 교훈: 모든 기술적 주장은 코드로 확인됩니다.
사례 3 - 과장이 사라졌습니다. 첫 번째 백서 초안에서 AI는 '위험 없는 고수익' 등의 표현을 사용했다. 팀에서는 이를 제거하고 정직한 위험 섹션을 추가했습니다. 이는 프로젝트를 윤리적으로나 법적으로 보호했습니다. 교훈: AI의 마케팅 편향은 반드시 감사되어야 합니다.
문서화의 윤리적 부담
Web3 문서는 사용자가 돈을 걸고 있는 상황에서 읽혀집니다. 따라서:
- 정직: 위험은 숨길 수 없으며 과장된 약속은 할 수 없습니다.
- 정확성: 기술적 주장은 코드와 일치해야 합니다. "문서에 그렇게 나와 있습니다"는 변호가 아니라 오히려 허위 진술입니다.
- 접근성: 사용자가 실제로 이해하는 언어로 작성하는 것은 보안 조치입니다. 이해되지 않는 문서는 속임수로의 초대입니다.
- 면책 조항: 이는 재정적 조언이나 규제 불확실성이 아니라는 점을 분명히 명시해야 합니다.
팁: Web3 문서의 정직성 테스트: "사용자가 이 문서만 신뢰하는 데 돈을 투자한다면 진실을 마주했을 때 속는 느낌을 받을까요?" 항상 AI가 위험 부분을 강조하도록 하되, 끝에 묻어두지 마세요.
일반적인 실수
- 코드로 기술적 주장을 확인하지 않습니다. 잘못된 문서는 사용자를 오해하게 만듭니다.
- 과대광고/마케팅 언어를 삭제합니다. 윤리적 및 법적 위험.
- 위험을 최소화하거나 숨깁니다. 신뢰 위반.
- AI에 실제 메커니즘을 제공하지 않고 백서를 인쇄합니다. 그것은 제작품을 생산합니다.
- "재정적인 조언이 아님" 경고를 무시합니다. 법적 의무.
- 문서와 코드의 동기화를 유지하지 않습니다. 코드가 변경되면 문서가 오해를 불러일으킬 수 있습니다.
요약하면
- 문서화는 Web3의 보안과 신뢰의 문제입니다. AI의 가장 생산적인 분야입니다.
- 오류로 인한 비용은 상대적으로 낮지만 허위 기술 주장과 과장은 심각한 위험입니다.
- 모든 기술적 주장은 실제 코드로 확인되어야 합니다. 문서는 코드를 대체하지 않습니다.
- 위험은 정직하고 눈에 띄게 작성되어야 합니다. 과장, 보증 문구는 삭제되어야 합니다.
- “재정적 조언이 아닙니다” 및 규제 경고는 필수입니다.
응용과제
스마트 계약 기능을 얻으세요. AI에게 "NatSpec 생성" 프롬프트를 제공하고 생성된 해석을 코드의 실제 동작과 한 줄씩 비교합니다. 불일치가 있습니까? 그런 다음 동일한 기능에 대해 "기술적 일반 번역"과 "위험/경고 섹션"을 생성합니다. 코드와 과장되거나 모순되는 AI의 진술을 하나 이상 찾아서 수정하세요.
체크리스트
- [ ] 모든 기술적 주장을 실제 코드로 확인했습니다.
- [ ] 과장/보증을 삭제했습니다.
- [ ] 위험요소를 솔직하게 작성하고 강조했습니다.
- [ ] AI에 실제 메커니즘을 부여했습니다. 나는 그가 그것을 구성하도록 두지 않았습니다.
- [ ] "이것은 재정적 조언이 아닙니다."라는 경고를 추가했습니다.
- [ ] 나는 차량과 제어를 위해 NatSpec 전체를 작성했습니다.
- [ ] 문서와 코드의 동기화를 유지할 계획이었습니다.