CommunityProduktivität & Zusammenarbeitgithub.com

karot0195/agent-skills-

Scannt ein Go-Projekt und erstellt/aktualisiert README.md mit Paketübersichten, Abhängigkeiten und Nutzungshinweisen.

Was ist agent-skills-?

Diese Fertigkeit ist darauf ausgelegt, die Dokumentation eines Go-Projekts zu automatisieren, indem sie den Quellcode durchläuft und eine umfassende README.md-Datei erstellt oder aktualisiert. Sie scannt die Projektstruktur, identifiziert Pakete, Binärdateien, Assets und Konfigurationsdateien, extrahiert Informationen aus go.mod wie Modulname und Go-Version und fasst APIs und Verhalten aus den wichtigsten Quelldateien jedes Pakets zusammen. Die generierte README.md enthält den Projektnamen, eine einzeilige Übersicht, die Verzeichnisstruktur, Paketbeschreibungen mit Schlüsseltypen und -funktionen, CLI-/Binärbeschreibungen sowie Abhängigkeiten. Dies ist besonders nützlich für Entwickler, die ihre Projektdokumentation schnell auf den neuesten Stand bringen möchten, ohne sie manuell zu pflegen. Sie wird auf der CLI von KI-Agenten wie Claude Code oder Cursor verwendet, die mit dem Dateisystem interagieren können.

Funktioniert mit~Claude Code~Codex CLI~Cursor
Part ofAgent Workflows
npx skills add https://github.com/karrot0195/agent-skills-/tree/HEAD/.agents/skills/gen-docs

Installed? Explore more Produktivität & Zusammenarbeit skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

Original anzeigen→Alle Skills durchsuchen

In Ihrer bevorzugten KI fragen

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

OpenAIChatGPTClaudeClaudeGeminiGeminiGrokGrokPerplexityPerplexityDeepSeekDeepSeek

Dokumentation

gen-docs

Verwenden Sie diese Fähigkeit, wenn der Benutzer bittet, ein Projekt zu scannen und die Dokumentation (z. B. README.md) zu aktualisieren.

Schritte

  1. Listen Sie das Projektverzeichnis auf und identifizieren Sie Pakete, Binärdateien, Assets und Konfigurationsdateien.
  2. Lesen Sie go.mod, um Modulname, Go-Version und Abhängigkeiten zu erfassen.
  3. Lesen Sie wichtige Quelldateien in jedem Paket, um APIs und Verhalten zusammenzufassen.
  4. Aktualisieren oder erstellen Sie README.md mit:
    • Projekttitel und einzeiliger Übersicht
    • Verzeichnisstruktur (Baum oder Liste)
    • Paketbeschreibungen mit wichtigen Funktionen/Typen
    • Beschreibungen zu Binärdateien/CLI
    • Abhängigkeiten und Anforderungen
  5. Bestätigen Sie den Dateipfad und fragen Sie, ob mehr Details (Beispiele, Nutzung) benötigt werden.

Wann zu verwenden

  • Der Benutzer sagt „Readme über Projektübersicht aktualisieren“
  • Der Benutzer bittet, „Projekt zu scannen und Dokumentation zu aktualisieren“
  • Der Benutzer möchte eine projektspezifische Dokumentation aus dem Quellcode generieren lassen

Individual skills in this repo

This repo contains 1 individual skill — each has its own dedicated page.

karrot0195/agent-skills-

Commit workflow that runs doc-gen first, stages only needed files (asking for confirmation on uncertain ones), suggests a message from the actual diff, commits, shows a summary, and asks about pushing.

Verwandte Skills

steipete/gemini

Gemini CLI one-shot prompts, summaries, generation, skills, hooks, MCP, or Gemma routing.

community

steipete/gh-issues

Fetch GitHub issues, select candidates, spawn background fix agents, open PRs, and optionally process PR review comments.

community

steipete/skill-creator

Create, edit, audit, tidy, validate, or restructure AgentSkills and SKILL.md files.

community

steipete/clawhub

Search, install, update, sync, or publish agent skills with the ClawHub CLI and registry.

community

steipete/coding-agent

Delegate coding work to Codex, Claude Code, or OpenCode as background workers; not simple edits or read-only code lookup.

community

steipete/mcporter

List, configure, authenticate, call, and inspect MCP servers/tools with mcporter over HTTP or stdio.

community
← More Produktivität & Zusammenarbeit skills