codebase-documenter

This skill enables creating comprehensive, beginner-friendly documentation for codebases. It provides structured templates and best practices for writing READMEs, architecture guides, code comments, and API documentation that help new users quickly understand and contribute to projects.

When documenting code for new users, follow these fundamental principles:

When to create: For project root directories, major feature modules, or standalone components.

يجب استخدام هذه المهارة عند كتابة الوثائق الخاصة بقواعد التعليمات البرمجية، بما في ذلك ملفات README، ووثائق الهندسة المعمارية، وتعليقات التعليمات البرمجية، ووثائق واجهة برمجة التطبيقات (API). استخدم هذه المهارة عندما يطلب المستخدمون المساعدة في توثيق التعليمات البرمجية الخاصة بهم، أو إنشاء أدلة البدء، أو شرح هيكل المشروع، أو تسهيل الوصول إلى قواعد التعليمات البرمجية للمطورين الجدد. توفر المهارة قوالب وأفضل الممارسات وأساليب منظمة لإنشاء وثائق واضحة وسهلة للمبتدئين. المصدر: mamba-mental/agent-skill-manager.