Webs

Prompt para un sitio de documentación de producto

Crea documentación con buscador, inicio rápido, resolución de problemas y versiones.

Revisión editorial · Vibe Coding ·

Cuándo usar este prompt

Para proyectos que disponen de instrucciones verificadas y un historial de versiones.

Instrucciones listas para copiar

Crea documentación pública de [PRODUCT] para [READERS]. El primer objetivo es [FIRST TASK]. Usa fuentes del proyecto e identifica ejemplos y comandos sin verificar.

Funciones e implementación:
1. Organiza inicio rápido, guías, referencia, solución de problemas y novedades. Indica requisitos, resultado esperado y siguiente paso.
2. Usa direcciones estables, títulos, índice local y rutas de navegación. Enlaza cada sección pública y prueba navegación móvil y con teclado.
3. Busca en títulos, texto y mensajes de error. Muestra la sección encontrada y gestiona consultas sin resultados. Excluye borradores del acceso público, buscador y sitemap.
4. Indica la versión aplicable, redirige páginas movidas y señala versiones archivadas. Los comandos copiables usan marcadores para credenciales.
5. Añade enlaces de edición o comentarios y fuentes verificables. Entrega y prueba una guía de inicio, un artículo de incidencias y una entrada de cambios.
Publica comandos por plataforma tras verificarlos. Comprueba encabezados, bloques de código y enlaces directos en el sitio generado. Abre resultados con teclado.

Datos que debes sustituir: [PRODUCT], [READERS], [FIRST TASK].

Trabaja primero para móvil, con HTML semántico y foco de teclado visible. Usa contenido real o datos de ejemplo claramente identificados. Incluye estados de carga, vacío, error y éxito en los flujos importantes. No afirmes que una integración funciona si solo existe la interfaz. Documenta lo pendiente y prueba el flujo principal antes de entregar.

Criterios de aceptación:
- El inicio rápido funciona en un entorno limpio.
- La búsqueda encuentra errores conocidos y excluye borradores.
- Una URL antigua redirige a la versión indicada.
Ver la referencia completa en inglés
Build public documentation for [PRODUCT] serving [READERS]. The most important first success is [FIRST TASK]. Use only source material supplied by the project. Mark sample values and flag unverified commands instead of inventing features.

1. Separate a quick start, task guides, reference, troubleshooting, and changelog. Each guide states prerequisites, expected results, and the next step. Show platform-specific commands only when verified.
2. Give each article a stable slug, visible page title, local table of contents, and breadcrumbs. Maintain a docs index with links to every public section. On narrow screens, make the navigation and search usable by touch and keyboard.
3. Search titles, body text, and error phrases. Show where each result comes from and handle no results. Exclude unpublished pages from search, sitemap, and anonymous access.
4. Put the current version and supported versions near affected instructions. Maintain redirects for moved pages and warn on archived versions. Copyable code must exclude shell prompts and use placeholders instead of credentials.
5. Include an edit or feedback link and a source for factual claims. Check the quick start from an empty project and verify all links, headings, and code blocks in the built output.

Deliver a sample quick start, a troubleshooting article, and a changelog entry. Verify direct URLs, keyboard search, and an old link that redirects to its replacement.

Modo de uso

  1. Elige un resultado

    Busca el tipo de página y recorrido que necesitas.

  2. Sustituye las variables

    Añade público, objetivo, contenido, diseño y restricciones reales.

  3. Edita antes de enviar

    Elimina funciones innecesarias y resuelve contradicciones.

  4. Prueba e itera

    Comprueba móvil, accesibilidad, interacciones, datos y casos límite.

Comparar herramientas de programación con IA

Resultado esperado

Documentación indexable con guías verificadas y versiones identificables.

Por qué funciona esta estructura

  • Organiza por tareas del lector
  • Incluye navegación estable y fuentes
  • Exige probar el inicio y los enlaces trasladados

Criterios de aceptación

  • El inicio rápido funciona en un entorno limpio.
  • La búsqueda encuentra errores conocidos y excluye borradores.
  • Una URL antigua redirige a la versión indicada.

Datos que debes sustituir

[PRODUCT]
Desarrolladores integrando una utilidad de terminal
[READERS]
Una CLI libre para redimensionar imágenes
[FIRST TASK]
Redimensionar una imagen y encontrar la salida

Fuentes y criterios

Las fuentes fundamentan el método y los requisitos técnicos. El prompt está redactado de forma original.

Todos los prompts de vibe coding

Preguntas frecuentes

Crea documentación con buscador, inicio rápido, resolución de problemas y versiones.

¿Qué construye este prompt?

Documentación indexable con guías verificadas y versiones identificables.

¿Qué debo personalizar antes de enviarlo?

Datos que debes sustituir · [PRODUCT], [READERS], [FIRST TASK]. Elimina funciones innecesarias y añade las restricciones técnicas, de marca y de contenido del proyecto.

¿Con qué herramientas puedo usarlo?

Vibe Coding, Lovable, Bolt. Comprueba el entorno, la base de datos, la autenticación y el despliegue.

¿Sirve para principiantes?

Nivel · Intermedio. Tiempo hasta el borrador · Depende de la herramienta. Revisa la interfaz, prueba las interacciones y verifica el comportamiento en producción.

¿Puedo editarlo antes de generar?

Sí. Copia el prompt completo y ajusta el texto en tu herramienta antes de enviarlo.

¿Cómo se revisó la plantilla?

La revisión editorial cubre objetivo, límites, estados, diseño adaptable y accesibilidad. Fuentes consultadas · Product Knowledge Hub, Google Search Essentials.

Copia la plantilla y empieza a construir

Sustituye las variables, elige la herramienta y verifica la salida con los criterios de aceptación.