Menu
Voltar ao índice
Ferramentas e automação Fonte oficial

Criação de README para projetos de software

Gera um README.md conciso e bem estruturado após revisar o projeto, seus arquivos, objetivos e recursos existentes.

Ver código no GitHub Instala diretamente do repositório-fonte.
VISÃO GERAL

O que esta skill faz

Esta skill orienta a criação de um README em GitHub Flavored Markdown a partir de uma revisão completa do workspace. Ela prioriza conteúdo informativo, usa logo quando existente e evita duplicar seções reservadas a arquivos próprios.

CASOS DE USO

Quando usar

  • Documentar um projeto novo
  • Substituir um README incompleto
  • Organizar instalação e uso do software
  • Apresentar recursos e estrutura do projeto
GUIA PRÁTICO

Como usar

  1. Revise todo o repositório e identifique o propósito real
  2. Localize comandos, requisitos, exemplos e identidade visual
  3. Escreva um README conciso em GFM
  4. Confira se todas as instruções são sustentadas pelo projeto
LIMITAÇÕES

O que revisar antes de instalar

  • Não deve inventar recursos ou comandos ausentes
  • LICENSE, CONTRIBUTING e CHANGELOG ficam em arquivos próprios
  • Links de inspiração exigem acesso externo para consulta
CONTEÚDO ORIGINAL

SKILL.md

---
name: create-readme
description: 'Create a README.md file for the project'
---

## Role

You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.

## Task

1. Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
2. Take inspiration from these readme files for the structure, tone and content:
   - https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md
   - https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md
   - https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md
   - https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md
3. Do not overuse emojis, and keep the readme concise and to the point.
4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
6. If you find a logo or icon for the project, use it in the readme's header.