CommunityCodierung & Entwicklunggithub.com

github/update-oo-component-documentation

Aktualisieren Sie vorhandene objektorientierte Komponentendokumentation gemäß bewährter Branchenpraktiken und Architekturdokumentationsstandards.

Was ist update-oo-component-documentation?

Diese Fähigkeit ist für die Aktualisierung bestehender objektorientierter (OO) Komponentendokumentation konzipiert und stellt sicher, dass sie mit aktuellen Industriestandards und Architekturrichtlinien konform bleibt. Sie richtet sich an Entwickler, die in OO-Sprachen wie Java, C++ oder Python arbeiten und deren Codebasis wächst. Der Skill analysiert vorhandene Dokumentation und Quellcodekommentare und schlägt Verbesserungen vor, die Klarheit, Vollständigkeit und Konsistenz verbessern. Er unterstützt gängige Entwicklungsumgebungen wie VS Code und JetBrains-IDEs und kann in CI/CD-Pipelines integriert werden. Typische Anwendungsfälle umfassen die Automatisierung von Dokumentationsüberprüfungen, die Sicherstellung der Einhaltung von Unternehmensstandards und die Erstellung von Änderungsprotokollen beim Refactoring von Komponenten. Durch die Verwendung der Fähigkeit können Teams den Zeitaufwand für manuelle Dokumentationsaktualisierungen reduzieren, das Verständnis zwischen Teammitgliedern verbessern und eine wartbare Architektur über Projektiterationen hinweg aufrechterhalten.

Funktioniert mit~Claude Code~Codex CLI~Cursor
Part ofReact
npx skills add https://github.com/github/awesome-copilot/tree/main/skills/update-oo-component-documentation

Installed? Explore more Codierung & Entwicklung skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · 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

Was macht update-oo-component-documentation?

Aktualisieren Sie vorhandene objektorientierte Komponentendokumentation gemäß bewährter Branchenpraktiken und Architekturdokumentationsstandards.

Beschreibung

Diese Fähigkeit überprüft automatisch vorhandene objektorientierte (OO) Komponentendokumentation und gleicht sie mit Industriestandards für Architektur- und Softwaredokumentation ab. Sie identifiziert Lücken, veraltete Abschnitte und Inkonsistenzen und generiert Aktualisierungen, die die Dokumentation auf dem neuesten Stand halten. Der Skill konzentriert sich auf Schlüsselaspekte wie Klassenspezifikationen, Vererbungshierarchien, Schnittstellenverträge und Abhängigkeitsdiagramme.

Verwendung

  1. Laden Sie den Skill in Ihre agentenbasierte Entwicklungsumgebung (z. B. Claude Code, Cursor).
  2. Bereiten Sie vorhandene Dokumentation vor: Stellen Sie sicher, dass die OO-Komponentendokumentation im Projektverzeichnis vorhanden ist (z. B. docs/components/).
  3. Ruft den Skill auf: Verwenden Sie einen Befehl oder eine Anfrage wie: 
    /skill update-oo-component-documentation --component UserAuthentication
  4. Überprüfen der Änderungen: Der Skill generiert einen Patch oder schlägt Änderungen direkt in der Dokumentation vor. Überprüfen und akzeptieren Sie sie nach Bedarf.

Anforderungen

  • Zugriff auf das Repository mit vorhandener OO-Codebasis und Dokumentation.
  • Unterstützte Plattformen: Claude Code, Cursor, Codex (oder andere kompatible Agenten).
  • Abhängigkeiten: git, python3 oder node (falls Skriptausführung erforderlich ist).

Konfiguration

Sie können den Skill konfigurieren, indem Sie eine .skillconfig-Datei im Stammverzeichnis des Projekts ablegen:

oo_components:
  doc_path: docs/components
  template: standard-oo-doc.md
  languages:
    - Java
    - Python
    - C++
  strict_mode: false

Beispiel

Vor:

# Klasse: Benutzer

Diese Klasse repräsentiert einen Benutzer.

Nach (vorgeschlagene Aktualisierung):

# Klasse: Benutzer

**Verantwortlichkeit:** Verwaltet Benutzerauthentifizierung und Profildaten.

**Vererbung:** Erbt von `BaseEntity`.

**Abhängigkeiten:** `DatabaseService`, `Logger`.

**Prinzipien:** Folgt dem Single-Responsibility-Prinzip.

Lizenz

Siehe LICENSE im Repository.

Individual skills in this repo

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

github/acquire-codebase-knowledge

Use this skill when the user explicitly asks to map, document, or onboard into an existing codebase. Trigger for prompts like "map this codebase", "document this architecture", "onboard me to this repo", or "create codebase docs". Do not trigger for routine feature implementation, bug fixes, or narrow code edits unless the user asks for repository-level discovery.

github/add-educational-comments

Add educational comments to the file specified, or prompt asking for file to comment if one is not provided.

github/agent-governance

Patterns and techniques for adding governance, safety, and trust controls to AI agent systems. Use this skill when: - Building AI agents that call external tools (APIs, databases, file systems) - Implementing policy-based access controls for agent tool usage - Adding semantic intent classification to detect dangerous prompts - Creating trust scoring systems for multi-agent workflows - Building audit trails for agent actions and decisions - Enforcing rate limits, content filters, or tool restrictions on agents - Working with any agent framework (PydanticAI, CrewAI, OpenAI Agents, LangChain, AutoGen)

github/agentic-eval

Patterns and techniques for evaluating and improving AI agent outputs. Use this skill when: - Implementing self-critique and reflection loops - Building evaluator-optimizer pipelines for quality-critical generation - Creating test-driven code refinement workflows - Designing rubric-based or LLM-as-judge evaluation systems - Adding iterative improvement to agent outputs (code, reports, analysis) - Measuring and improving agent response quality

github/agent-owasp-compliance

Check any AI agent codebase against the OWASP Agentic Security Initiative (ASI) Top 10 risks. Use this skill when: - Evaluating an agent system's security posture before production deployment - Running a compliance check against OWASP ASI 2026 standards - Mapping existing security controls to the 10 agentic risks - Generating a compliance report for security review or audit - Comparing agent framework security features against the standard - Any request like "is my agent OWASP compliant?", "check ASI compliance", or "agentic security audit"

github/ai-prompt-engineering-safety-review

Comprehensive AI prompt engineering safety review and improvement prompt. Analyzes prompts for safety, bias, security vulnerabilities, and effectiveness while providing detailed improvement recommendations with extensive frameworks, testing methodologies, and educational content.

github/appinsights-instrumentation

Instrument a webapp to send useful telemetry data to Azure App Insights

github/apple-appstore-reviewer

Serves as a reviewer of the codebase with instructions on looking for Apple App Store optimizations or rejection reasons.

github/architecture-blueprint-generator

Comprehensive project architecture blueprint generator that analyzes codebases to create detailed architectural documentation. Automatically detects technology stacks and architectural patterns, generates visual diagrams, documents implementation patterns, and provides extensible blueprints for maintaining architectural consistency and guiding new development.

github/arch-linux-triage

Triage and resolve Arch Linux issues with pacman, systemd, and rolling-release best practices.

github/arize-ai-provider-integration

Creates, reads, updates, and deletes Arize AI integrations that store LLM provider credentials used by evaluators and other Arize features. Supports any LLM provider (e.g. OpenAI, Anthropic, Azure OpenAI, AWS Bedrock, Vertex AI, Gemini, NVIDIA NIM). Use when the user mentions AI integration, LLM provider credentials, create integration, list integrations, update credentials, delete integration, or connecting an LLM provider to Arize.

github/arize-annotation

Creates and manages annotation configs (categorical, continuous, freeform label schemas) and annotation queues (human review workflows) on Arize. Applies human annotations to project spans via the Python SDK. Use when the user mentions annotation config, annotation queue, label schema, human feedback, bulk annotate spans, update_annotations, labeling queue, annotate record, or human review.

github/arize-dataset

Creates, manages, and queries Arize datasets and examples. Covers dataset CRUD, appending examples, exporting data, and file-based dataset creation using the ax CLI. Use when the user needs test data, evaluation examples, or mentions create dataset, list datasets, export dataset, append examples, dataset version, golden dataset, or test set.

github/arize-evaluator

Handles LLM-as-judge evaluation workflows on Arize including creating/updating evaluators, running evaluations on spans or experiments, managing tasks, trigger-run operations, column mapping, and continuous monitoring. Use when the user mentions create evaluator, LLM judge, hallucination, faithfulness, correctness, relevance, run eval, score spans, score experiment, trigger-run, column mapping, continuous monitoring, or improve evaluator prompt.

github/arize-experiment

Creates, runs, and analyzes Arize experiments for evaluating and comparing model performance. Covers experiment CRUD, exporting runs, comparing results, and evaluation workflows using the ax CLI. Use when the user mentions create experiment, run experiment, compare models, model performance, evaluate AI, experiment results, benchmark, A/B test models, or measure accuracy.

github/arize-instrumentation

Adds Arize AX tracing to an LLM application for the first time. Follows a two-phase agent-assisted flow to analyze the codebase then implement instrumentation after user confirmation. Use when the user wants to instrument their app, add tracing from scratch, set up LLM observability, integrate OpenTelemetry or openinference, or get started with Arize tracing.

github/arize-link

Generates deep links to the Arize UI for traces, spans, sessions, datasets, labeling queues, evaluators, and annotation configs. Produces clickable URLs for sharing Arize resources with team members. Use when the user wants to link to or open a trace, span, session, dataset, evaluator, or annotation config in the Arize UI.

github/arize-prompt-optimization

Optimizes, improves, and debugs LLM prompts using production trace data, evaluations, and annotations. Extracts prompts from spans, gathers performance signal, and runs a data-driven optimization loop using the ax CLI. Use when the user mentions optimize prompt, improve prompt, make AI respond better, improve output quality, prompt engineering, prompt tuning, or system prompt improvement.

github/arize-trace

Downloads, exports, and inspects existing Arize traces and spans to understand what an LLM app is doing or debug runtime issues. Covers exporting traces by ID, spans by ID, sessions by ID, and root-cause investigation using the ax CLI. Use when the user wants to look at existing trace data, see what their LLM app is doing, export traces, download spans, investigate errors, or analyze behavior regressions.

github/aspire

Aspire skill covering the Aspire CLI, AppHost orchestration, service discovery, integrations, MCP server, VS Code extension, Dev Containers, GitHub Codespaces, templates, dashboard, and deployment. Use when the user asks to create, run, debug, configure, deploy, or troubleshoot an Aspire distributed application.

Verwandte Skills

steipete/bluebubbles

Send and manage iMessages via BlueBubbles, including attachments, tapbacks, edits, replies, and groups.

community

steipete/eightctl

Control Eight Sleep pods (status, temperature, alarms, schedules).

community

steipete/blucli

BluOS CLI (blu) for discovery, playback, grouping, and volume.

community

steipete/bear-notes

Create, search, and manage Bear notes via grizzly CLI.

community

steipete/camsnap

Capture frames or clips from RTSP/ONVIF cameras.

community

steipete/gifgrep

Search GIF providers with CLI/TUI, download results, and extract stills/sheets.

community
← More Codierung & Entwicklung skills