Communitygithub.com

Readme Generator

Erstellen Sie umfassende und hochwertige README.md-Dateien für Code-Repositories. Verwenden Sie dieses Skill, wenn der Benutzer darum bittet, ein README zu erstellen, zu schreiben, zu generieren, zu aktualisieren oder zu verbessern.

Was ist Readme Generator?

Der README Generator Skill analysiert automatisch den Quellcode eines Projekts und generiert daraus eine professionelle, gut strukturierte README.md-Datei. Der Skill führt eine vierphasige Analyse durch: Projekt-Metadaten, Architektur, tiefgehende Modulanalyse und Unterstützungsinfrastruktur. Er stellt lediglich gezielte Rückfragen zu Aspekten, die aus dem Code nicht ersichtlich sind (z.B. Projektzweck, Setup-Besonderheiten oder Ansprechpartner). Das Ergebnis ist eine README mit allen wichtigen Abschnitten wie Übersicht, Architektur (inkl. Mermaid-Diagrammen), Getting Started, Umgebungsvariablen, API-Referenz, Fehlerbehebung und Kontakt – angereichert mit Shield.io-Badges und praxisnahen Code-Beispielen. Der Skill ist plattformunabhängig und funktioniert mit jeder Art von Codebasis (z.B. Python, Node.js, Docker). Er spart Entwicklerteams erheblich Zeit, indem er das lästige Schreiben von READMEs automatisiert und gleichzeitig Konsistenz und Vollständigkeit sicherstellt.

Funktioniert mit~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/cdcoonce/Portfolio_Website/tree/HEAD/.claude/skills/readme-generator

In Ihrer bevorzugten KI fragen

Öffnet einen neuen Chat, in dem dieser Agent-Skill bereits geladen ist.

Vorschau

Aus dem Skill-README

Sprache

Dokumentation

Was macht Readme Generator?

Erstellen Sie ansprechende, umfassende README.md-Dateien für interne/unternehmenseigene Code-Repositories, indem Sie die eigentliche Codebasis analysieren und gezielte klärende Fragen stellen.

Warum dieses Skill existiert

Ein gutes README ist die Visitenkarte eines Code-Repositories. Speziell für interne Projekte bedeutet ein fehlendes oder dünnes README, dass jedes neue Teammitglied Stunden damit verbringt, herauszufinden, was ein Projekt tut, wie man es ausführt und wo man suchen muss. Dieses Skill automatisiert die Schwerstarbeit – es liest den Code, leitet ab, was es kann, fragt nach, was es nicht kann, und erstellt ein README, das Entwickler schnell produktiv macht.

Workflow

Schritt 1: Analysieren der Codebasis

Bevor Sie den Benutzer etwas fragen, führen Sie eine strukturierte Vier-Phasen-Analyse durch, um so viel Kontext wie möglich zu sammeln. Dies reduziert die Belastung des Benutzers – er sollte nur Lücken füllen müssen, nicht Dinge beschreiben, die Sie bereits sehen können.

Markieren Sie jede Tatsache mit einem Vertrauensgrad: [bestätigt] (aus der Quelle gelesen), [abgeleitet-hoch] (starke Evidenz), [abgeleitet-niedrig] (teilweise Evidenz) oder [unbekannt]. Erkenntnisse mit niedrigem Vertrauensgrad oder unbekannte Erkenntnisse werden in Schritt 2 zu klärenden Fragen.

Siehe references/analysis-phases.md für detaillierte Tool-Aktionen, Grep-Muster, Extraktions-Checklisten und Vorlagen für Aufzeichnungen.

Phase 1 – Projekt-Metadaten-Scan: Durchsuchen Sie das Dateisystem nach Paketmanager-Dateien (pyproject.toml, package.json usw.), Umgebungsvorlagen, Dockerfiles, CI/CD-Konfigurationen und Toolchain-Dateien. Lesen Sie jede und extrahieren Sie: Projektname/-version, Sprache, Abhängigkeiten (kategorisiert mit Zwecken), Skripte/Befehle, Umgebungsvariablen (erforderlich vs. optional), CI-Stufen, Lizenz.

Phase 2 – Architektur-Scan: Durchsuchen Sie das Dateisystem nach allen Quelldateien, um die Verzeichnisstruktur abzubilden. Suchen Sie mit Grep nach Einstiegspunkt-Markern (if __name__, main(), usw.) und lesen Sie jeden Einstiegspunkt. Erstellen Sie den Import-Graphen, indem Sie mit Grep nach Import-Anweisungen in allen Quelldateien suchen – klassifizieren Sie Module als Kern (hoher Eingangsgrad), Blatt oder Orchestrator. Identifizieren Sie das Architekturmuster (Pipeline, MVC, geschichtet, Microservices, ereignisgesteuert, CLI, Monolith) mithilfe der Indikator-Checkliste. Suchen Sie mit Grep nach Konfigurations-Lade-Mustern, um Laufzeitkonfigurationsdateien zu finden.

Phase 3 – Tiefgehende Modulanalyse: Lesen Sie jede bedeutende Quelldatei (priorisiert: Kern → Einstiegspunkt → Größte → Rest). Extrahieren Sie für jede: Zweck (ein Satz), wichtige Exporte mit Signaturen, Design-Notizen (nicht offensichtliche Entscheidungen, Randfälle, Konventionen) und interne Abhängigkeiten. Verfolgen Sie den primären Workflow Ende-zu-Ende durch den Import-Graphen und beschriften Sie, welche Datentypen zwischen Modulen fließen. Bei Codebasen mit 8+ Quelldateien entsenden Sie parallele Sub-Agenten, gruppiert nach Abhängigkeits-Clustern.

Phase 4 – Unterstützungsinfrastruktur-Scan: Durchsuchen Sie das Dateisystem nach Testdateien und Fixtures. Lesen Sie die ersten 30-50 Zeilen jeder Testdatei, um eine Test-zu-Modul-Zuordnung zu erstellen. Suchen Sie mit Grep nach benutzerdefinierten Ausnahmeklassen und raise-Anweisungen, um die Fehlerhierarchie abzubilden. Scannen Sie Vorlagen, Assets und vorhandene Dokumente. Extrahieren Sie häufige Fehlerszenarien für die Tabelle zur Fehlerbehebung.

Schritt 2: Klärende Fragen stellen

Fragen Sie den Benutzer nach der Analyse nach Dingen, die Sie nicht mit Sicherheit ableiten konnten. Bleiben Sie fokussiert – fragen Sie nicht nach Dingen, die Sie bereits wissen. Häufige Lücken sind:

  • Projektzweck: Welches Problem löst dies? Wer nutzt es? (falls nicht offensichtlich aus dem Code)
  • Setup-Besonderheiten: Gibt es nicht offensichtliche Voraussetzungen, VPN-Anforderungen, interne Paketregister oder Datenbank-Setup-Schritte?
  • Wichtige Workflows: Was sind die 2-3 Dinge, die ein Entwickler mit diesem Projekt am häufigsten tut?
  • Bereitstellung: Wie/Wo wird dies bereitgestellt? (falls nicht aus CI/CD-Konfigurationen ersichtlich)
  • Team-Konventionen: Gibt es Namenskonventionen, Branching-Strategien oder Muster, die erwähnt werden sollten?
  • Kontaktinformationen: Wer besitzt/verwaltet dieses Projekt? (Name + E-Mail für den Kontakt-Abschnitt)

Präsentieren Sie Ihre Fragen prägnant. Wenn die Codebasis unkompliziert ist und Sie mit Ihrer Analyse zuversichtlich sind, benötigen Sie möglicherweise nur 1-2 Fragen – oder sogar keine. Verwenden Sie Ihr Urteilsvermögen.

Schritt 3: README.md generieren

Schreiben Sie das README unter Verwendung der untenstehenden Struktur und Richtlinien.

README-Struktur

Verwenden Sie dies als Ihre Vorlage. Fügen Sie alle Abschnitte ein, aber skalieren Sie die Tiefe entsprechend der Komplexität des Projekts. Verwenden Sie --- horizontale Trennlinien zwischen jedem Hauptabschnitt für visuelle Struktur.

# Projektname

![Sprache](https://img.shields.io/badge/...) ![Framework](https://img.shields.io/badge/...) ![Tool](https://img.shields.io/badge/...)

Kurze, klare Beschreibung. Verwenden Sie **fett** für die wichtigste Technologie oder den Produkttyp.

---

## Inhaltsverzeichnis

Erstellen Sie ein gründliches, verschachteltes Inhaltsverzeichnis, das ALLE ## und ### Überschriften enthält. Rückeln Sie Unterabschnitte unter ihre übergeordneten Abschnitte ein, damit Leser die vollständige Struktur auf einen Blick sehen können. Dies ist besonders wichtig für längere READMEs – das Inhaltsverzeichnis dient sowohl als Navigationswerkzeug als auch als Gliederung des gesamten Dokuments.

Beispiel der erwarteten Tiefe:

- [Übersicht](#übersicht)
- [Architektur](#architektur)
  - [Hochrangige Architektur](#hochrangige-architektur)
  - [Verzeichnisstruktur](#verzeichnisstruktur)
  - [Modul-Abhängigkeitsgraph](#modul-abhängigkeitsgraph)
- [Erste Schritte](#erste-schritte)
  - [Voraussetzungen](#voraussetzungen)
  - [Installation](#installation)
  - [Ausführen von Tests](#ausführen-von-tests)
- [Umgebungsvariablen](#umgebungsvariablen)
- [Nutzung](#nutzung)
  - [Beispiel: Primärer Anwendungsfall](#beispiel-primärer-anwendungsfall)
  - [Beispiel: Sekundärer Anwendungsfall](#beispiel-sekundärer-anwendungsfall)
- [API-Referenz](#api-referenz)
  - [Ressource A](#ressource-a)
  - [Ressource B](#ressource-b)
- [Fehlerbehebung](#fehlerbehebung)
- [Kontakt](#kontakt)
- [Lizenz](#lizenz)

Jede ### Überschrift im Dokument sollte als eingerückter Eintrag unter ihrer übergeordneten ## Überschrift erscheinen. Überspringen Sie keine Unterabschnitte – der ganze Sinn eines gründlichen Inhaltsverzeichnisses ist, dass Leser direkt zu jedem Teil des Dokuments springen können.

---

## Übersicht

Erweitern Sie die Beschreibung. Machen Sie Schlüsselbegriffe fett. Verwenden Sie nummerierte Listen für mehrschrittige Prozesse.

---

## Architektur

### Hochrangige Architektur

```mermaid
graph TD
    ...
```

Verzeichnisstruktur

projekt-root/
├── src/           # Kurze Anmerkung
├── tests/         # Kurze Anmerkung
└── ...

[Datenfluss / Pipeline / Modul-Abhängigkeiten – zusätzliche Diagramme]

...

Erste Schritte

Voraussetzungen

Installation

Ausführen von Tests


Umgebungsvariablen

VariableErforderlichBeschreibung
DB_URLJaPostgreSQL-Verbindungszeichenfolge

Nutzung

Reale Codebeispiele für die 2-3 häufigsten Operationen.


API-Referenz


Fehlerbehebung

SymptomWahrscheinliche UrsacheLösung
FehlermeldungWas ist falschWie man es behebt

Kontakt

Bei Fragen oder Support kontaktieren Sie:


Lizenz

Nur für internen Gebrauch – Firmenname Proprietäre Software. © [Jahr] [Firma]. Alle Rechte vorbehalten.


## Shield.io Badges

Fügen Sie immer Shield.io-Badges direkt nach der `# Titel`-Überschrift ein (3-6 Badges, die Sprache, Framework, Schlüsselbibliothek, Paketmanager, Datenbank, Infrastruktur abdecken). Siehe [references/badge-reference.md](references/badge-reference.md) für Format, Beispiele und Farbvorschläge nach Kategorie.

## Mermaid-Diagramm-Richtlinien

Verwenden Sie Mermaid-Diagramme großzügig – sie machen Architektur, Datenflüsse und Prozesse sofort verständlich. Ein typisches README sollte **3-6 Diagramme** enthalten; komplexe Projekte (Datenpipelines, Multiservice-Systeme) könnten **6-10+** haben. Siehe [references/mermaid-guidelines.md](references/mermaid-guidelines.md) für Informationen, wann welcher Diagrammtyp verwendet werden sollte, Best Practices und projektspezifische Empfehlungen.

## Schreibrichtlinien

- **Seien Sie spezifisch statt allgemein.** „Führen Sie `npm run dev` aus“ ist besser als „Starten Sie den Entwicklungsserver“. Fügen Sie tatsächliche Befehle, Dateipfade und Variablennamen ein.
- **Schreiben Sie für das neue Teammitglied.** Gehen Sie von allgemeinen Ingenieurfähigkeiten aus, aber ohne Projektkontext.
- **Machen Sie Schlüsselbegriffe und Produktnamen fett** bei der ersten Erwähnung und in Übersichten. Dies hilft Lesern beim Scannen.
- **Verwenden Sie nummerierte Listen für sequenzielle Prozesse.** „1. **Extrahiert** Daten aus X. 2. **Transformiert** sie. 3. **Lädt** in Y.“ – machen Sie das Verb fett.
- **Codebeispiele sollten ausführbar sein.** Kopieren Sie nach Möglichkeit aus der tatsächlichen Codebasis.
- **Umgebungsvariablen-Tabellen sind nicht verhandelbar.** Listen Sie jede einzelne auf.
- **Fehlerbehebung im Tabellenformat** (Symptom | Wahrscheinliche Ursache | Lösung) – scannbar und konsistent.
- **Anmerkungen zur Verzeichnisstruktur sollten kurz sein.** Ein kurzer Satz pro Verzeichnis.
- **Fügen Sie immer einen Kontaktabschnitt ein.** Fragen Sie den Benutzer, wer das Projekt verwaltet. Format: `**Name** — [email protected]`.
- **Verwenden Sie `---` horizontale Trennlinien** zwischen allen Hauptabschnitten für visuelle Struktur.

## Ausgabe

Speichern Sie das README als `README.md` im Stammverzeichnis des Repositories (oder im aktuellen Arbeitsverzeichnis, wenn kein Repository-Stamm identifizierbar ist). Wenn bereits eine README.md existiert, bestätigen Sie mit dem Benutzer, bevor Sie überschreiben – er möchte möglicherweise Teile davon behalten.

Individual skills in this repo

This repo contains 20 individual skills — each has its own dedicated page.

cdcoonce/Portfolio_Website

Git commit workflow with enforced conventional commit style. Use when Claude needs to stage and commit changes, craft commit messages, or the user asks to commit, make a commit, or save their work. Ensures consistent commit message format, proper scoping, and atomic commits across the project.

cdcoonce/Portfolio_Website

AI-powered code quality analysis for Python, Markdown, and Mermaid diagrams. Use this skill when: (1) reviewing code for quality issues, (2) checking Python files for PEP8 violations, unused code, missing type hints, docstring problems, complexity issues, or potential runtime errors, (3) validating Markdown documentation for broken links, heading structure, or formatting issues, (4) validating Mermaid diagram syntax, (5) the user asks for a "code review" or "quality check", (6) analyzing code snippets pasted in conversation, or (7) suggesting and applying fixes for code quality issues.

cdcoonce/Portfolio_Website

Deploy the portfolio chat agent Lambda function to AWS. Use when the user asks to deploy, redeploy, push to Lambda, update the chat agent, or after updating context files or lambda_function.py. Rebuilds the knowledge base, packages dependencies, and deploys to AWS Lambda.

cdcoonce/Portfolio_Website

Generate multiple radically different interface designs for a module using parallel sub-agents. Use when user wants to design an API, explore interface options, compare module shapes, or mentions "design it twice".

cdcoonce/Portfolio_Website

Orchestrate the full GitHub-issues-driven development lifecycle. 7-phase pipeline from brainstorm through PR with state tracking and cross-conversation resume. Use when user says "dev cycle", "development workflow", "full development pipeline", or invokes /dev-cycle.

cdcoonce/Portfolio_Website

Production Python coding standards with automatic version detection (3.10-3.13). Use when writing, reviewing, or refactoring Python to ensure adherence to modern type syntax, LBYL exception handling, pathlib operations, ABC-based interfaces, and production-tested patterns. Not Dagster-specific - applies to any Python project.

cdcoonce/Portfolio_Website

Set up Claude Code hooks to block dangerous git commands (push, reset --hard, clean, branch -D, etc.) before they execute. Use when user wants to prevent destructive git operations, add git safety hooks, or block git push/reset in Claude Code.

cdcoonce/Portfolio_Website

GitHub CLI (gh) integration for managing issues, pull requests, branches,

cdcoonce/Portfolio_Website

Interview the user relentlessly about a plan or design until reaching shared understanding, resolving each branch of the decision tree. Use when user wants to stress-test a plan, get grilled on their design, or mentions "grill me".

cdcoonce/Portfolio_Website

Explore a codebase to find opportunities for architectural improvement, focusing on making the codebase more testable by deepening shallow modules. Use when user wants to improve architecture, find refactoring opportunities, consolidate tightly-coupled modules, or make a codebase more AI-navigable.

cdcoonce/Portfolio_Website

CEO/founder-mode plan review. Rethink the problem, find the 10-star product, challenge premises, expand scope when it creates a better product. Three modes: SCOPE EXPANSION (dream big), HOLD SCOPE (maximum rigor), SCOPE REDUCTION (strip to essentials). Use when the user asks for a plan review, CEO review, mega review, or wants a plan challenged/stress-tested before implementation.

cdcoonce/Portfolio_Website

Break a PRD into independently-grabbable GitHub issues using tracer-bullet vertical slices. Use when user wants to convert a PRD to issues, create implementation tickets, or break down a PRD into work items.

cdcoonce/Portfolio_Website

Turn a PRD into a multi-phase implementation plan using tracer-bullet vertical slices, saved as a local Markdown file in docs/plans/. Use when user wants to break down a PRD, create an implementation plan, plan phases from a PRD, or mentions "tracer bullets".

cdcoonce/Portfolio_Website

Generate or update the `.claude/docs/project.md` file that gives Claude project-specific context. Use this skill when the user asks to create, update, regenerate, or refresh project context, or says things like "update project.md", "generate project context", "this repo needs a project.md", or "Claude doesn't know about this project". Also trigger when onboarding Claude to a new repository for the first time.

cdcoonce/Portfolio_Website

Create a detailed refactor plan with tiny commits via user interview, then file it as a GitHub issue. Use when user wants to plan a refactor, create a refactoring RFC, or break a refactor into safe incremental steps.

cdcoonce/Portfolio_Website

Set up pre-commit hooks for the current repo. Use when user wants to add pre-commit hooks, configure commit-time linting, formatting, type checking, or testing. Triggers on "pre-commit", "git hooks", "linting hooks", or /setup-pre-commit.

cdcoonce/Portfolio_Website

Test-driven development with red-green-refactor loop. Use when user wants to build features or fix bugs using TDD, mentions "red-green-refactor", wants integration tests, or asks for test-first development.

cdcoonce/Portfolio_Website

Triage a bug or issue by exploring the codebase to find root cause, then create a GitHub issue with a TDD-based fix plan. Use when user reports a bug, wants to file an issue, mentions "triage", or wants to investigate and plan a fix for a problem.

cdcoonce/Portfolio_Website

Rewrites the prose sections of wiki pages in-place. Reads source files to understand current context, then updates only the content inside <!-- claude:prose --> ... <!-- claude:prose:end --> markers. Never touches <!-- generated:start --> ... <!-- generated:end --> blocks. Supports targeting a single page with /update-wiki {PageName}.

cdcoonce/Portfolio_Website

Create a PRD through user interview, codebase exploration, and module design, then submit as a GitHub issue. Use when user wants to write a PRD, create a product requirements document, or plan a new feature.

Verwandte Skills