S Skillteca
Receber por email
Explorar Categorias Coleções Newsletter
← Voltar para o catálogo

readme-review

Design e Frontend Autor: 686f6c61

Auditar y mejorar el README del proyecto: estructura, completitud y claridad. Activar ante: mejorar README, auditar README, primera impresion del proyecto, readme incompleto

57estrelas
Atualizado há 4 meses
Ver no GitHub ↗

Como adicionar

/plugin marketplace add 686f6c61/alfred-dev

O comando exato pode variar conforme o repositório. Confira o README no GitHub.

Para o autor da skill

Cole no README do seu repo

Mostra que sua skill está catalogada na Skillteca, gera backlink e tráfego rastreável.

[![Skillteca](https://www.skillteca.com.br/api/badge/readme-review/svg)](https://www.skillteca.com.br/skills/readme-review)

Skills relacionadas

Ver todas de Design e Frontend →

frontend-design

153.1k 2

Cria interfaces frontend distintas e de nível de produção com alta qualidade de design, gerando código criativo e polido e design de UI que evita a estética genérica de IA. Use para construir componentes web, páginas e aplicações, ou para estilizar/embelezar UIs web.

Design e Frontend #ai #css por anthropics

mcp-builder

153.1k

Guia para criar servidores MCP (Model Context Protocol) de alta qualidade que permitem que LLMs interajam com serviços externos por meio de ferramentas bem projetadas. Use ao construir servidores MCP para integrar APIs ou serviços externos, seja em Python (FastMCP) ou Node/TypeScript (MCP SDK).

Design e Frontend #api #llm por anthropics

webapp-testing

153.1k

Kit de ferramentas para interagir e testar aplicações web locais usando Playwright. Suporta a verificação de funcionalidades de frontend, depuração de comportamento da UI, captura de screenshots do navegador e visualização de logs do navegador.

Design e Frontend #test por anthropics

web-artifacts-builder

153.1k

Conjunto de ferramentas para criar artefatos HTML elaborados e multi-componentes para claude.ai, utilizando tecnologias web frontend modernas (React, Tailwind CSS, shadcn/ui). Use para artefatos complexos que exigem gerenciamento de estado, roteamento ou componentes shadcn/ui, não para artefatos HTML/JSX simples de arquivo único.

Design e Frontend #ai #css por anthropics

Alerta por categoria

Receba novas skills de Design e Frontend toda segunda

1 email curto, só com as skills novas de Design e Frontend. 4 minutos de leitura, sem spam, cancela com 1 clique.

Você confirma o email no primeiro envio. Sem spam. Cancela com 1 clique.

Ler descrição completa

Revisión del README

Resumen

Este skill audita el README del proyecto de forma sistemática. El README es la primera impresión del proyecto: si está vacío, desactualizado o confuso, el visitante se va. Un buen README responde en menos de 30 segundos a las preguntas: qué es esto, para qué sirve y cómo lo uso.

Proceso

Paso 1: leer el README actual

  • Si no existe, crearlo desde cero con la estructura base.
  • Si existe, leerlo completo y evaluar cada sección.

Paso 2: verificar secciones obligatorias

Comprobar que el README tiene, como mínimo:

  1. Título y descripción: qué es el proyecto, en una frase.
  2. Instalación: cómo instalarlo paso a paso. Probarlo desde cero.
  3. Uso rápido: ejemplo mínimo de cómo usarlo (código o comando).
  4. Requisitos: dependencias, versiones mínimas, sistema operativo.
  5. Licencia: qué licencia tiene y dónde leerla.

Paso 3: verificar secciones recomendadas

Evaluar si faltan y si serían útiles:

  • Contribución: cómo contribuir al proyecto.
  • Configuración: variables de entorno, ficheros de configuración.
  • Tests: cómo ejecutar los tests.
  • Arquitectura: enlace a documentación detallada si existe.
  • Changelog: enlace al changelog o sección con cambios recientes.

Paso 4: revisar calidad del contenido

  • Actualizado: la información refleja el estado actual del código?
  • Completo: un desarrollador nuevo puede arrancar solo con el README?
  • Claro: se entiende sin conocimiento previo del proyecto?
  • Ortografía: tildes, concordancia, sin erratas.
  • Formateo: markdown correcto, bloques de código con lenguaje, enlaces que funcionen.

Paso 5: entregar informe y correcciones

  • Lista de hallazgos con severidad (falta sección crítica, texto desactualizado, error menor).
  • Correcciones directas para los problemas encontrados.
  • Sugerencias de mejora para las secciones que existen pero podrían ser mejores.

Qué NO hacer

  • No añadir badges innecesarios solo por estética.
  • No escribir párrafos largos en el README. Preferir listas y ejemplos de código.
  • No duplicar documentación extensa: el README enlaza a docs/, no lo reemplaza.
Compartilhar X LinkedIn