documentation
كتابة وثائق أفضل
こちらからも入手できます: DaoThiHuong2111,Joseph OBrien,Joseph OBrien,sickn33,CrazySwami
غالباً ما تنتهي الوثائق غير منظمة وصعبة القراءة. توفر هذه المهارة إرشادات واضحة لإنشاء ملفات markdown منظمة بشكل جيد مع هيكل وتنسيق وتسلسل هرمي بصري مناسب.
スキルZIPをダウンロード
Claudeでアップロード
設定 → 機能 → スキル → スキルをアップロードへ移動
オンにして利用開始
テストする
「documentation」を使用しています。 Write a getting started guide for my Python project
期待される結果:
- • Creates getting-started.md with headers for prerequisites, installation, quick start, and examples
- • Uses code blocks for commands and configuration snippets
- • Adds bullet points for quick reference steps
- • Writes directly to the file and tells you the location
「documentation」を使用しています。 Create a project proposal for a new feature
期待される結果:
- • Generates proposal.md with problem statement, solution, timeline, and outcomes
- • Uses clear sections with headers for easy navigation
- • Maintains persuasive but honest tone appropriate for proposals
- • Saves to proposals folder with descriptive naming
「documentation」を使用しています。 Document the API endpoints for my REST service
期待される結果:
- • Creates api.md with sections for each endpoint
- • Uses tables for request/response formats
- • Includes code examples for each operation
- • Organizes by resource type for logical flow
セキュリティ監査
安全Pure prompt-based skill containing only documentation guidelines. No code execution, no file access beyond standard AI capabilities, no network calls, and no external commands. Static findings are false positives - the analyzer misidentified documentation-related text as cryptographic references and markdown backticks as shell execution. This is a set of best practices for writing documentation.
リスク要因
🌐 ネットワークアクセス (1)
⚙️ 外部コマンド (2)
品質スコア
作れるもの
إنشاء وثائق تقنية
كتابة ملفات README ووثائق الأدلة وواجهات برمجة التطبيقات الواضحة مع هيكل مناسب
صياغة خطط المشاريع
إنشاء خطط ومقترحات قابلة للتنفيذ مع خطوات ملموسة وتدفق منطقي
تنسيق المحتوى الطويل
تنظيم ملاحظات العصف الذهني والأدلة والمواصفات مع رؤوس وتسلسل هرمي بصري
これらのプロンプトを試す
Write a README for my project in PROJECT/README.md. Include sections for overview, installation, usage, and contributing.
Create API documentation in docs/api.md. Document the main endpoints, request/response formats, and authentication.
Write a project proposal in proposals/feature-x.md. Include problem statement, proposed solution, timeline, and expected outcomes.
Create architecture documentation in docs/architecture.md. Include system overview, component diagram, data flow, and design decisions.
ベストプラクティス
- اكتب دائماً إلى ملف بدلاً من إلقاء المحتوى الطويل في المحطة
- استخدم رؤوساً لإنشاء هيكل واضح وقابلية للتنقل
- قسم النص باستخدام القوائم والجداول وكتل الكود لقابلية القراءة
回避
- إلقاء المحتوى الطويل مباشرة في المحطة بدون ملف
- تجاهل غرض المستند عند اختيار النبرة والهيكلة
- استخدام جدران من النص بدون تنسيق أو تسلسل هرمي بصري