readme-blueprint-generator

Par github · awesome-copilot

Prompt de génération intelligente de README.md qui analyse la structure de la documentation d'un projet et crée une documentation de dépôt complète. Parcourt les fichiers du répertoire `.github/copilot` et le fichier `copilot-instructions.md` pour extraire les informations du projet, la stack technologique, l'architecture, le workflow de développement, les normes de codage et les approches de test, tout en générant une documentation Markdown bien structurée avec un formatage soigné, des références croisées et un contenu orienté développeur.

npx skills add https://github.com/github/awesome-copilot --skill readme-blueprint-generator

README Generator Prompt

Générez un README.md complet pour ce repository en analysant les fichiers de documentation du répertoire .github/copilot et le fichier copilot-instructions.md. Suivez ces étapes :

  1. Scannez tous les fichiers du dossier .github/copilot, comme :

    • Architecture
    • Code_Exemplars
    • Coding_Standards
    • Project_Folder_Structure
    • Technology_Stack
    • Unit_Tests
    • Workflow_Analysis
  2. Révisez également le fichier copilot-instructions.md dans le dossier .github

  3. Créez un README.md avec les sections suivantes :

Project Name and Description

  • Extrayez le nom du projet et l'objectif principal de la documentation
  • Incluez une description concise de ce que fait le projet

Technology Stack

  • Listez les technologies, langages et frameworks principaux utilisés
  • Incluez les informations de version si disponibles
  • Tirez ces informations principalement du fichier Technology_Stack

Project Architecture

  • Fournissez une vue d'ensemble de haut niveau de l'architecture
  • Envisagez d'inclure un diagramme simple s'il est décrit dans la documentation
  • Tirez du fichier Architecture

Getting Started

  • Incluez les instructions d'installation basées sur la stack technologique
  • Ajoutez les étapes de configuration et de setup
  • Incluez tous les prérequis

Project Structure

  • Vue d'ensemble brève de l'organisation des dossiers
  • Tirez du fichier Project_Folder_Structure

Key Features

  • Listez les fonctionnalités et caractéristiques principales du projet
  • Extrayez de divers fichiers de documentation

Development Workflow

  • Résumez le processus de développement
  • Incluez les informations sur la stratégie de branchement si disponibles
  • Tirez du fichier Workflow_Analysis

Coding Standards

  • Résumez les normes de codage et conventions clés
  • Tirez du fichier Coding_Standards

Testing

  • Expliquez l'approche et les outils de test
  • Tirez du fichier Unit_Tests

Contributing

  • Directives pour contribuer au projet
  • Référencez tous les exemplaires de code pour des conseils
  • Tirez des fichiers Code_Exemplars et copilot-instructions

License

  • Incluez les informations de licence si disponibles

Formatez le README avec un Markdown approprié, incluant :

  • Des titres et sous-titres clairs
  • Des blocs de code le cas échéant
  • Des listes pour une meilleure lisibilité
  • Des liens vers d'autres fichiers de documentation
  • Des badges pour le statut de build, la version, etc. si les informations sont disponibles

Gardez le README concis mais informatif, en mettant l'accent sur ce que les nouveaux développeurs ou utilisateurs auraient besoin de savoir sur le projet.

Skills similaires