CommunityProductivité et collaborationgithub.com

karoot0195/agent-skills-gen-docs

Analyser un projet Go et générer/mettre à jour le README.md avec des aperçus de packages, dépendances et notes d'utilisation.

Qu'est-ce que agent-skills-gen-docs ?

Cette compétence permet de générer ou mettre à jour automatiquement la documentation d'un projet Go, notamment le fichier README.md. Elle analyse la structure du projet, lit les fichiers sources clés et extrait les informations sur les packages, les binaires, les dépendances et la configuration. Idéale pour les développeurs qui souhaitent maintenir une documentation à jour sans effort manuel, elle fonctionne avec n'importe quel projet Go standard. L'outil propose également de détailler des exemples d'utilisation si nécessaire, garantissant une documentation complète et pertinente.

Compatible avec~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 Productivité et collaboration skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

Voir l'original→Voir toutes les compétences

Demander à votre IA préférée

Ouvre une nouvelle conversation avec cette compétence d'agent déjà préchargée.

OpenAIChatGPTClaudeClaudeGeminiGeminiGrokGrokPerplexityPerplexityDeepSeekDeepSeek

Documentation

gen-docs

Utilisez cette compétence lorsque l'utilisateur demande d'analyser un projet et de mettre à jour la documentation (ex. README.md).

Étapes

  1. Lister la racine du projet et identifier les packages, binaires, ressources et fichiers de configuration.
  2. Lire go.mod pour capturer le nom du module, la version de Go et les dépendances.
  3. Lire les fichiers sources clés de chaque package pour résumer les API et le comportement.
  4. Mettre à jour ou créer README.md avec :
    • Titre du projet et aperçu en une ligne
    • Structure du répertoire (arborescence ou liste)
    • Descriptions des packages avec les fonctions/types clés
    • Descriptions des binaires/CLI
    • Dépendances et prérequis
  5. Confirmer le chemin du fichier et demander si plus de détails (exemples, utilisation) sont nécessaires.

Quand utiliser

  • L'utilisateur dit "mettre à jour le readme avec un aperçu du projet"
  • L'utilisateur demande d'"analyser le projet et mettre à jour la doc"
  • L'utilisateur souhaite une documentation au niveau du projet générée à partir du code source

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.

Skills associés

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 Productivité et collaboration skills