Developer guide
Write a developer guide—quick start, setup, project layout, workflow and FAQs—so a new engineer can ship a change on day one.
Prompt
Write a developer guide (README) for a SaaS project built with Next.js and Go. Purpose: get a new engineer running the project locally and shipping a first change on day one. Requirements: open with a quick start of copy-pasteable commands in order with expected output, state required runtime and tool versions and how to start local services, list environment variables in a table, explain the directory layout and where new code goes, walk through branching, everyday commands, testing and code review, and close with common errors and fixes and where to get help. Use code blocks for commands, in a friendly, direct tone.
- Fuente
- Ofox
Cómo usarlo
- 1
Pulsa «Crear uno igual»
Ofox Chat se abre con la estructura de este documento ya preparada. Inicia sesión primero si no lo has hecho.
- 2
Hazlo tuyo
Edita las partes resaltadas del prompt para poner tus propios detalles.
- 3
Envía y crea
Envíalo y Ofox Chat redacta el documento completo para que lo descargues. Sigue conversando para revisarlo.
Preguntas frecuentes
¿Qué tipo de archivo obtengo?
Un documento completo y descargable (Word o PDF), no solo un bloque de texto en el chat.
¿Necesito preparar algo?
No: puedes enviarlo tal cual y Ofox Chat escribe una primera versión a partir de la plantilla. Si añades contexto, datos o documentos que ya tengas (pegados o subidos como PDF, Word y otros archivos), el resultado se ajustará mucho mejor a tu caso.
¿Puedo editar el prompt?
Sí. El prompt se carga en el cuadro de texto de Ofox Chat y, antes de enviarlo, puedes cambiar el tema por el tuyo, añadir requisitos o quitar lo que no necesites.
¿Puedo copiar y usar el prompt directamente?
Sí. Toca «Copiar» en la tarjeta del prompt para obtener el texto plano; también funciona en otras herramientas de escritura con IA.
Más como este
Más prompts de Ingeniería- Technical design docExplain how a system or feature will be built—architecture, data model, APIs and alternatives—and assess performance, risks, rollout and rollback.Ingeniería
- API referenceDocument auth, conventions, error codes, and each endpoint's parameters and examples so developers can complete the integration on their own.Ingeniería
- Incident postmortemReconstruct a production incident on a timeline, quantify its impact, trace the root cause, and set owned, dated actions to prevent a repeat.Ingeniería
- Technology evaluationWeigh candidate technologies against criteria set by business needs, score them with evidence, and recommend one with risks and a rollout plan.Ingeniería
- Test planDefine what to test, how, where, and when testing is done for a release or project, aligning QA, engineering and product on expectations.Ingeniería
- Release runbookTurn a deployment into a step-by-step runbook: pre-release checks, numbered steps, post-release verification, and rollback with clear triggers.Ingeniería
- Coding standardsSet shared coding standards: rules ranked must vs. should for naming, structure, error handling, security and reviews, each with examples.Ingeniería
- Database design docDocument the data layer: entity relationships, tables and constraints, the query behind each index, volume estimates and archiving.Ingeniería
- Migration planPlan a system or data migration: inventory, strategy, data sync and validation, phased cutover, and rollback at every stage.Ingeniería
- Performance test reportReport a performance test: throughput, latency percentiles and resource use against targets, the bottlenecks found, and a go/no-go call.Ingeniería
¿Tienes tu propia idea? Empieza a crear
Describe en una frase la imagen que quieres y Ofox Chat la crea desde cero.