CommunityProduktivität & Zusammenarbeitgithub.com

mtai0524/claude-skills

Halte README.md und Projektdokumentation synchron, wenn Funktionen, Setup oder Konfiguration geändert werden. Verwende dies nach Hinzufügen einer Funktion, Änderung von Setup-Schritten, Hinzufügen von Umgebungsvariablen oder wenn der Benutzer eine Aktualisierung der Dokumentation wünscht.

Was ist claude-skills?

Dieser Skill wurde entwickelt, um sicherzustellen, dass die README.md-Datei eines Projekts und deren zugehörige Dokumentation stets aktuell bleiben, sobald sich die Funktionalität, das Setup oder die Konfiguration ändert. Entwickler können den Skill gezielt nach dem Hinzufügen neuer Features, nach Änderungen an Installations- oder Setup-Schritten, nach dem Einfügen neuer Umgebungsvariablen oder auf expliziten Benutzerwunsch zur Aktualisierung der Dokumente einsetzen. Der Skill unterstützt alle Projekte, die eine README.md verwenden, und arbeitet plattformunabhängig. Er bearbeitet selektiv nur die relevanten Abschnitte der README, testet jede dokumentierte Befehl auf Korrektheit und hält sich an eine klare, kurze und marketingfreie englische Sprache, um die Dokumentation präzise und nützlich zu halten. Der Skill ist ideal für CI/CD-Pipelines oder als Teil einer regelmäßigen Codeüberprüfung, um die Dokumentation als Single Source of Truth zu bewahren.

Funktioniert mit✓Claude Code~Codex CLI~Cursor
Part ofAgent Workflows
npx skills add https://github.com/mtai0524/claude-skills/tree/HEAD/skills/docs-readme

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

Dokumentation & README

Wenn eine Änderung sich darauf auswirkt, wie jemand das Projekt installiert, ausführt, konfiguriert oder verwendet, aktualisiere die README.md in derselben Änderung.

Die README sollte kurz abdecken:

  • Was das Projekt ist (1-2 Sätze).
  • Voraussetzungen und Installationsschritte.
  • Wie man ausführt, testet und baut – kopierbare Befehle.
  • Konfiguration: jede Umgebungsvariable mit Zweck und Beispielwert (niemals echte Geheimnisse).
  • Kurze Nutzungsbeispiele für Hauptfunktionen.

Regeln:

  • Bearbeite nur die Abschnitte, die von der Änderung betroffen sind; schreibe nicht die gesamte Datei neu.
  • Überprüfe, ob jeder dokumentierte Befehl tatsächlich funktioniert.
  • Englisch, kurze Sätze, keine Marketingsprache.

Individual skills in this repo

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

mtai0524/claude-skills

Branch naming convention and the rule to branch before changing code on the default branch (main/master). Use when starting new work, creating a branch, or when about to edit code while on the default branch.

mtai0524/claude-skills

Update CHANGELOG.md from commits since the last tag, following Keep a Changelog. Use when the user asks to update the changelog or prepare a release.

mtai0524/claude-skills

Write git commit messages in Conventional Commits format. Use whenever creating a commit, when the user asks for a commit message, and at the end of every task that changed files (to propose the commit message).

mtai0524/claude-skills

Systematic debugging that finds and fixes the root cause instead of patching symptoms. Use for any bug, error, failing test, or unexpected behavior.

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