tech-doc
كتابة توثيق تقني عالي الجودة
حوّل المعلومات التقنية المتفرقة إلى توثيق واضح ومنظم يمكن للفرق استخدامه فعليًا. توفر هذه المهارة أطر عمل مثبتة للكتابة تجعل المحتوى التقني سهل الوصول والصيانة.
スキルZIPをダウンロード
Claudeでアップロード
設定 → 機能 → スキル → スキルをアップロードへ移動
オンにして利用開始
テストする
「tech-doc」を使用しています。 وثّق نقطة نهاية API المصادقة الجديدة الخاصة بنا
期待される結果:
- # Authentication API
- The authentication API validates user credentials and returns JWT tokens for authorized access.
- ## Quick Start
- POST /api/auth/login with username and password to receive a JWT token.
- ## API Reference
- - Endpoint: POST /api/auth/login
- - Headers: Content-Type: application/json
- - Body: {"username": "string", "password": "string"}
- - Response: {"token": "jwt_string", "expires": "timestamp"}
- ## Common Errors
- 401 Unauthorized: Invalid credentials provided
「tech-doc」を使用しています。 أنشئ SOP للنشر
期待される結果:
- ## Deploy Microservice
- Deploy the containerized microservice to the staging environment.
- ## Prerequisites
- - Docker installed
- - kubectl configured
- - Access to container registry
- ## Command
- kubectl apply -f deployment.yaml --dry-run=client
- ## Common Errors
- ImagePullBackOff: Verify container registry credentials
セキュリティ監査
安全This is a documentation-only skill containing writing guidelines for technical documentation. No executable code, network calls, file system access, or environment variables are present. All 18 static findings are false positives triggered by documentation keywords being misinterpreted as security-sensitive terms (e.g., 'hash', 'structure', 'auth' in plain text descriptions). The skill is purely instructional content for writing quality technical documentation.
リスク要因
🌐 ネットワークアクセス (1)
⚙️ 外部コマンド (3)
品質スコア
作れるもの
توحيد توثيق الفريق
أنشئ معايير كتابة متسقة عبر فريقك التقني لتحسين جودة التوثيق وسهولة القراءة.
كتابة توثيق API أفضل
أنشئ توثيق API واضحًا وموجزًا يتبع أفضل الممارسات الصناعية ويساعد المستخدمين على التكامل بسرعة.
تحسين مشاركة المعرفة
طبّق إرشادات التوثيق التي تضمن توثيق ومشاركة المعرفة التقنية الحيوية بشكل صحيح.
これらのプロンプトを試す
ساعدني في كتابة توثيق لنقطة نهاية REST API الخاصة بنا باستخدام إرشادات tech-doc لإنشاء دليل واضح ومنظم.
أنشئ إجراء تشغيل قياسي لنشر خدماتنا المصغرة باستخدام معايير تنسيق tech-doc مع المتطلبات المسبقة والأخطاء الشائعة.
اكتب شرحًا تقنيًا لبنيتنا المعمارية الموجهة بالأحداث وفقًا لإرشادات tech-doc مع نهج الاستنتاج أولاً.
طوّر توثيقًا شاملاً لخط أنابيب البيانات الخاص بنا بما في ذلك المقدمة والبنية المعمارية والنشر واستكشاف الأخطاء باستخدام معايير tech-doc.
ベストプラクティス
- ابدأ دائمًا باستنتاج واضح قبل شرح التفاصيل
- استخدم مصطلحات متسقة في جميع أنحاء التوثيق
- قدّم أمثلة عملية يمكن للمستخدمين نسخها وتنفيذها
回避
- كتابة فقرات طويلة دون هيكل أو عناوين واضحة
- إضافة افتراضات أو معلومات غير موجودة في المادة المصدر
- استخدام الصيغة المبنية للمجهول أو تراكيب جمل معقدة بشكل مفرط