المهارات readme
📦

readme

آمن

Umfassende README-Dokumentation erstellen

Dieses Skill erstellt umfassende README.md-Dokumentation für jedes Projekt, einschließlich Setup, Architektur, Deployment und Fehlerbehebung. Perfekt für Entwickler, die vollständige Projektdokumentation ohne manuelles Schreiben wünschen.

يدعم: Claude Codex Code(CC)
⚠️ 62 ضعيف
1

تنزيل ZIP المهارة

2

رفع في Claude

اذهب إلى Settings → Capabilities → Skills → Upload skill

3

فعّل وابدأ الاستخدام

اختبرها

استخدام "readme". Create a README for my Rails app

النتيجة المتوقعة:

Generiert ein umfassendes README mit: Projekttitel und Übersicht, Tech-Stack-Tabelle, Voraussetzungen, Schritt-für-Schritt-Anleitung zum Starten, Verzeichnisstrukturerklärung, Datenbankschema, Umgebungsvariablen-Referenz, verfügbare Scripts, Testing-Anleitung, Deployment-Anleitung für erkannte Plattform, Troubleshooting-Abschnitt

استخدام "readme". Document my Node.js project

النتيجة المتوقعة:

Erstellt README mit: Projektbeschreibung, Abhängigkeiten, Setup-Anweisungen, npm Scripts-Referenz, Umgebungskonfiguration, Architekturübersicht, Deployment-Anleitung für erkannte Plattform (Vercel, Render, etc.), häufige Troubleshooting-Schritte

التدقيق الأمني

آمن
v1 • 2/24/2026

All 268 static findings are FALSE POSITIVES. This is a documentation generation skill that provides instructions for writing README files. The flagged patterns (external commands, environment variables, URLs) are all example content within the documentation templates, not actual code execution or credential access. No real security risks identified.

1
الملفات التي تم فحصها
843
الأسطر التي تم تحليلها
5
النتائج
1
إجمالي عمليات التدقيق

مشكلات عالية المخاطر (5)

SKILL.md:75-842
External Commands False Positive
Static scanner flagged 208 instances of 'external_commands' (Ruby/shell backtick execution) - these are example commands in documentation templates, not actual code execution. The skill generates README documentation and does not execute any commands.
SKILL.md:190-633
Environment Access False Positive
Static scanner flagged 16 instances of 'env_access' (DATABASE_URL, SECRET_KEY_BASE, etc.) - these are documented environment variables in example documentation, not actual environment access.
SKILL.md:4-377
Network Access False Positive
Static scanner flagged 6 instances of 'network' (URLs, SMTP settings) - these are example URLs and configuration documentation, not actual network requests.
SKILL.md:45-770
Sensitive Files False Positive
Static scanner flagged references to credentials files (.env.example, credentials.yml.enc, master.key) - these are documentation about configuration files, not actual file access.
SKILL.md:3-555
Weak Cryptographic Algorithm False Positive
Static scanner flagged 10 instances of 'weak cryptographic algorithm' - these are standard Rails terms (encrypted_password, credentials.yml.enc) in documentation, not actual crypto implementation.
تم تدقيقه بواسطة: claude

درجة الجودة

38
الهندسة المعمارية
100
قابلية الصيانة
87
المحتوى
26
المجتمع
55
الأمان
91
الامتثال للمواصفات

ماذا يمكنك بناءه

Neue Projektdokumentation

Generieren Sie ein vollständiges README für ein neu erstelltes Projekt, um Setup und Architektur von Anfang an zu dokumentieren.

Legacy-Projekt README-Update

Aktualisieren Sie veraltete README-Dateien mit aktuellen Setup-Anweisungen, Architekturdetails und Deployment-Schritten.

Open-Source-Projekt-Verbesserung

Erstellen Sie umfassende Dokumentation für Open-Source-Projekte, um das Onboarding von Contributors zu verbessern.

جرّب هذه الموجهات

Basis-README-Generierung 
Erstellen Sie eine README.md für dieses Projekt mit dem readme Skill. Erkunden Sie zuerst die Codebase, um die Struktur zu verstehen.
Bestehendes README aktualisieren 
Aktualisieren Sie die vorhandene README.md mit gründlicherer Dokumentation. Das aktuelle README ist veraltet und wichtige Abschnitte fehlen.
Deployment-Abschnitt hinzufügen 
Fügen Sie einen Deployment-Abschnitt zu unserer README hinzu. Überprüfen Sie auf Deployment-Konfigurationsdateien wie Dockerfile, docker-compose.yml oder Deploy-Konfigurationen.
Vollständige Dokumentations-Überarbeitung 
Erstellen Sie eine absurd gründliche README, die alles abdeckt: lokales Setup, Architektur-Tiefenanalyse, Umgebungsvariablen, Testing, Deployment und Troubleshooting.

أفضل الممارسات

  • Lassen Sie das Skill die Codebase vollständig erkunden, bevor Sie Dokumentation generieren, für准确Inhalte
  • Gewähren Sie Zugriff auf alle Konfigurationsdateien (.env.example, database.yml, etc.) für vollständige Dokumentation
  • Überprüfen Sie generierte Umgebungsvariablen-Tabellen und fügen Sie fehlende sensible Werte hinzu

تجنب

  • Bitten Sie das Skill nicht, ein Projekt zu dokumentieren, ohne ihm vorher Dateizugriff zu gewähren
  • Unterbrechen Sie nicht die Erkundungsphase - lassen Sie es alle Projektdetails sammeln
  • Erwarten Sie nicht, dass das Skill Geschäftslogik kennt, die nicht im Code ersichtlich ist

الأسئلة المتكررة

Welche Frameworks unterstützt dieses Skill?
Dieses Skill funktioniert mit jedem Framework. Es erkennt Ruby/Rails, Node.js, Python, Go und mehr durch die Untersuchung von Projektdateien. Es passt dann die Dokumentation entsprechend an.
Funktioniert es mit Monorepos?
Das Skill kann Monorepos dokumentieren, ben aber möglicherweise Anleitung, welche Pakete oder Dienste im Fokus stehen sollen. Geben Sie Kontext über die Projektstruktur.
Kann es ein vorhandenes README aktualisieren?
Ja. Das Skill kann ein vorhandenes README lesen und es mit fehlenden Abschnitten erweitern oder es vollständig mit gründlicherem Inhalt neu schreiben.
Welche Deployment-Plattformen erkennt es?
Es erkennt Docker, Kamal, Heroku, Fly.io, Render, Vercel, Netlify, AWS Elastic Beanstalk, Serverless, Kubernetes und generische VPS-Deployments.
Wie gründlich ist die generierte Dokumentation?
Das Ziel ist 'absurd gründliche' Dokumentation. Sie enthält Setup-, Architektur-, Umgebungsvariablen-, Scripts-, Testing-, Deployment- und Troubleshooting-Abschnitte.
Führt dieses Skill Befehle aus?
Nein. Dies ist ein Dokumentations-Generierungs-Skill. Es liest nur Dateien, um das Projekt zu verstehen, und generiert Markdown-Dokumentation. Es führt keine Befehle aus.

تفاصيل المطور

المؤلف

sickn33

الترخيص

MIT

المستودع

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/readme

مرجع

main

بنية الملفات

📄 SKILL.md