وحدة 8 / 11

التوثيق والكتابة الفنية: ورقة العمل، NatSpec ودليل المستخدم

المكاسب:

  • القدرة على استخدام الذكاء الاصطناعي بأمان في إنتاج المستندات التقنية وNatSpec والترجمة التقنية البسيطة والكشف عن المخاطر وفهم أن هذا هو المجال الأكثر إنتاجية.
  • القدرة على التحقق من كل مطالبة فنية باستخدام الكود الفعلي وإزالة المبالغة ولغة الضمان لتجنب مخاطر التوثيق غير الصحيح
  • القدرة على تحمل المخاطر بأمانة، والتحذير "وليس المشورة المالية" واتساق كود التوثيق

التوثيق في Web3 ليس ترفًا، ولكنه مسألة أمان وثقة. من خلال التفاعل مع العقد الذكي، يخاطر المستخدم بأمواله الحقيقية؛ إذا لم يفهم ما يفعله، فهو عرضة للخداع. لا يمكن للمدقق مراجعة التعليمات البرمجية غير الموثقة بشكل آمن بأمان. في هذه الوحدة، نغطي المجال الذي يكون فيه الذكاء الاصطناعي أكثر موثوقية وكفاءة: التوثيق والكتابة الفنية. من المستندات التقنية إلى التعليقات المضمنة في التعليمات البرمجية، ومن دليل المستخدم إلى الكشف عن المخاطر، يعد الذكاء الاصطناعي قوة مضاعفة حقيقية هنا - طالما تتم مراقبة الدقة بشكل إنساني.

أنواع وثائق Web3

  • الورقة البيضاء/الورقة الورقية: الوثيقة الأساسية التي تصف رؤية المشروع وآليةه ورمزيته.
  • الوثائق الفنية: واجهات العقد، دليل التكامل للمطورين.
  • NatSpec (مواصفات اللغة الطبيعية للإيثريوم - تنسيق التعليق القياسي في الكود في Solidity الذي يصف ما تفعله الوظائف): الوثائق المضمنة في التعليمات البرمجية، والتي يقرأها كل من الإنسان والأداة.
  • دليل المستخدم: نص عادي يخبر المستخدم النهائي "كيفية الاستخدام، وما هي المخاطر الموجودة".
  • إخلاء المسؤولية: التحذيرات المطلوبة قانونيًا وأخلاقيًا.

مشكلة شائعة في هذه الأنواع: المطورون لا يحبون الكتابة وغالبًا ما يتركونها حتى اللحظة الأخيرة. الذكاء الاصطناعي يملأ هذه الفجوة بالضبط.

لماذا يعد التوثيق المجال الأكثر أمانًا في الذكاء الاصطناعي؟

تكلفة الخطأ في التوثيق أقل منها في التدقيق: يتم تصحيح جملة واحدة غير صحيحة، ولا يطير المال (مباشرة). بالإضافة إلى ذلك، الذكاء الاصطناعي قوي بشكل طبيعي في إنتاج اللغة. لذا فإن الذكاء الاصطناعي فعال وآمن نسبيًا هنا. ولكن لا يزال هناك خطران حاسمان:

  1. ادعاء فني كاذب: قد يحرف الذكاء الاصطناعي ما تفعله التعليمات البرمجية؛ يؤدي هذا إلى تضليل المستخدم ويمكن أن يصبح ثغرة أمنية (ما لم يُذكر "هذه الوظيفة تحمي أموالك" ولا تفعل ذلك).
  2. المبالغة/لغة التسويق: يمكن للذكاء الاصطناعي إنتاج لغة تجعل المشروع يبدو آمنًا أو مربحًا؛ وهذه مشكلة أخلاقية وقانونية على حد سواء.
تنبيه: تصف الوثائق التعليمات البرمجية؛ إنه ليس الكود نفسه. يجب التحقق من كل تأكيد تقني يكتبه الذكاء الاصطناعي ("يحدث هذا"، "يحافظ") مقابل الكود الفعلي. يمكن أن تكون الوثائق غير الصحيحة أكثر خطورة من التعليمات البرمجية الصحيحة لأن المستخدم يثق في الوثائق.

طبقات استخدام الذكاء الاصطناعي في التوثيق

1. جيل NatSpec. يقرأ الذكاء الاصطناعي وظيفة موجودة ويصيغ تفسير NatSpec: ما الذي يفعله، وما هي معلماته، وما الذي يُرجعه. وهذا يبسط التفتيش والصيانة.

2. الترجمة التقنية البسيطة. يقوم الذكاء الاصطناعي بترجمة آلية معقدة إلى لغة يمكن للمستخدم النهائي فهمها، وهو أحد أكبر احتياجات Web3.

3. الخطوط العريضة للورقة البيضاء وهيكلها. يقوم الذكاء الاصطناعي بإنتاج الهيكل العظمي وأجزاء من الورقة البيضاء؛ دقة المحتوى أمر بشري.

4. تعدد اللغات وتعديل المستوى. يمكن للذكاء الاصطناعي إنتاج نفس المحتوى، التقني والعادي، باللغتين التركية والإنجليزية.

موجه ضعيف / موجه قوي

حث ضعيف:

اكتب ورقة بيضاء لهذا المشروع.

يقوم الذكاء الاصطناعي باختلاق نسخة مبالغ فيها، وربما كاذبة، ومليئة بالتسويق دون معرفة الآلية الفعلية.

مطالبة قوية:

دورك: الكاتب الفني لـ Web3. يوجد أدناه الآلية الحقيقية والرمزية ورمز المشروع. اكتب مسودة ورقة بيضاء بناءً على هذه المعلومات فقط. القواعد: - لا تبالغ، ولا تستخدم عبارات مثل "ربح مضمون"، "آمن تمامًا" وما إلى ذلك. - اعتمد كل مطالبة فنية على الآلية التي أقدمها؛ لا تضف تلفيقًا. - أضف قسم "المخاطر" الذي يوضح المخاطر بوضوح. - أضف تحذيرًا "هذه ليست نصيحة مالية". ضع علامة على أي معلومات لست متأكدًا منها أو لا أملكها على أنها [مطلوب ملؤها].

أربعة قوالب قابلة للنسخ

1) جيل NatSpec:

اكتب تعليقات NatSpec القياسية على الوظيفة التالية: @notice (ماذا يفعل، عادي)، @dev (ملاحظة فنية)، @param و@return. اكتب فقط ما يفعله الكود فعليًا؛ إضافة سلوك غير موجود في التعليمات البرمجية. ضع علامة على التأثير الذي لست متأكدًا منه.

2) الترجمة التقنية البسيطة:

اشرح هذه الآلية باللغة التركية البسيطة والتي يمكن لمستخدم العملات المشفرة المبتدئ أن يفهمها: ماذا تفعل، ماذا يجب على المستخدم أن يفعل، ما هي المخاطر الموجودة؟ مبالغة؛ لا يوجد ضمان للأمن. لا تخفي المخاطر، بل أبرزها إلى الواجهة.

3) قسم المخاطر/التحذير:

اكتب قسم "المخاطر والتحذيرات" الصادق لهذا المشروع: مخاطر العقود الذكية، ومخاطر السوق، ومخاطر السيولة، وعدم اليقين التنظيمي، والخسارة الرئيسية. اشرح كل خطر بلغة واضحة. لا تقلل من شأن المخاطر؛ تنتهي بـ "هذه ليست نصيحة مالية".

4) التحقق من اتساق كود التوثيق:

فيما يلي الوظيفة والوثائق المتاحة لها. قم بوضع علامة على الأماكن التي يتعارض فيها المستند مع السلوك الفعلي للتعليمات البرمجية أو يحذفه. اتخاذ القرار النهائي؛ إرساله إلى "التحقق من المطور".

ثلاث حالات صغيرة (بالأرقام)

الحالة 1 - كثفت NatSpec التفتيش. قدم أحد الفرق عقدًا مكونًا من 25 وظيفة للمراجعة دون تعليق؛ طلب المدقق وقتًا إضافيًا لفهم المنطق. أنتج الفريق مسودات NatSpec باستخدام الذكاء الاصطناعي وأكد كل منها باستخدام الكود؛ تم اختصار عملية إعداد التدقيق لمدة يوم واحد تقريبًا. الدرس المستفاد: التوثيق الجيد يقلل من تكلفة التدقيق.

الحالة 2 - تم القبض على ادعاء كاذب. ينص دليل المستخدم الذي أنتجته YZ على أنه "قد يتم سحب أموالك في أي وقت"؛ بينما كان هناك قفل لمدة 7 أيام في العقد. لقد اكتشفت المراجعة الفنية هذا. إذا تم نشره، سيكون المستخدمون مخطئين ويقعون ضحية. الدرس المستفاد: يتم تأكيد كل مطالبة فنية بواسطة الكود.

الحالة الثالثة - تم توضيح المبالغة. في المسودة الأولى للورقة البيضاء، استخدم الذكاء الاصطناعي تعبيرات مثل "عائد مرتفع دون مخاطر". قام الفريق بإزالة هذه العناصر وإضافة قسم المخاطر الصادقة. وهذا يحمي المشروع أخلاقيا وقانونيا. الدرس المستفاد: يجب مراجعة التحيز التسويقي للذكاء الاصطناعي.

العبء الأخلاقي للتوثيق

تتم قراءة وثائق Web3 في سياق يخاطر فيه المستخدم بأمواله. لذلك:

  • الصدق: لا يمكن إخفاء المخاطر ولا تقديم الوعود المبالغ فيها.
  • الدقة: يجب أن تتطابق المطالبات الفنية مع الكود؛ "الوثيقة تقول ذلك" ليست دفاعا، بل تحريف.
  • إمكانية الوصول: الكتابة باللغة التي يفهمها المستخدم فعليًا هي إجراء أمني؛ الوثيقة غير المفهومة هي دعوة للخداع.
  • إخلاء المسؤولية: يجب الإشارة بوضوح إلى أن هذه ليست نصيحة مالية أو عدم يقين تنظيمي.
نصيحة: اختبار الصدق لمستند Web3: "إذا وضع المستخدم المال في الثقة بهذه الوثيقة فقط، فهل سيشعر بالخداع عندما يواجه الحقيقة؟" اجعل الذكاء الاصطناعي يسلط الضوء دائمًا على جزء المخاطر، وليس دفنه في النهاية.

الأخطاء الشائعة

  • عدم تأكيد المطالبة الفنية بالكود. المستند الخاطئ يضلل المستخدم.
  • إسقاط لغة الضجيج/التسويق. المخاطر الأخلاقية والقانونية.
  • التقليل من المخاطر أو إخفائها. خرق الثقة.
  • طباعة ورقة بيضاء دون إعطاء الآلية الحقيقية للذكاء الاصطناعي. وتنتج افتراءات.
  • تجاهل تحذير "ليست نصيحة مالية". التزام قانوني.
  • عدم الحفاظ على الوثائق متزامنة مع التعليمات البرمجية. عندما يتغير الرمز، يصبح المستند مضللاً.

باختصار

  • يعد التوثيق مسألة أمان وثقة في Web3؛ إنه المجال الأكثر إنتاجية للذكاء الاصطناعي.
  • تكلفة الخطأ منخفضة نسبيًا، لكن الادعاءات الفنية الكاذبة والمبالغة تشكل مخاطر جسيمة.
  • يجب تأكيد كل مطالبة فنية بواسطة رمز حقيقي؛ المستند لا يحل محل التعليمات البرمجية.
  • ينبغي كتابة المخاطر بأمانة وبشكل بارز؛ ويجب إزالة لغة المبالغة والضمان.
  • "إنها ليست نصيحة مالية" والتحذيرات التنظيمية إلزامية.

مهمة التطبيق

احصل على وظيفة العقد الذكي. أعط الذكاء الاصطناعي موجه "Generate NatSpec" وقارن بين التفسير الذي تم إنشاؤه سطرًا تلو الآخر مع السلوك الفعلي للكود - هل هناك أي خلافات؟ ثم قم بإنتاج "ترجمة تقنية بسيطة" و"قسم المخاطر/التحذير" لنفس الوظيفة. ابحث عن عبارة واحدة على الأقل من الذكاء الاصطناعي وصححها مبالغ فيها أو تتعارض مع الكود.

قائمة مرجعية

  • [ ] لقد أكدت كل مطالبة فنية بالكود الفعلي.
  • [ ] أزلت المبالغة/الضمانات.
  • [ ] كتبت المخاطر بأمانة وأبرزتها.
  • [ ] أعطيت الذكاء الاصطناعي الآلية الحقيقية؛ لم أسمح له باختلاق الأمر.
  • [ ] أضفت التحذير "هذه ليست نصيحة مالية."
  • [ ] كتبت NatSpec بالكامل للمركبة والتحكم.
  • [ ] لقد خططت للحفاظ على الوثائق متزامنة مع الكود.