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.
- Source
- Ofox
Comment l’utiliser
- 1
Cliquez sur « Créer le même »
Ofox Chat s’ouvre avec la structure de ce document déjà prête. Connectez-vous d’abord si ce n’est pas fait.
- 2
Personnalisez
Modifiez les parties surlignées du prompt pour y mettre vos propres détails.
- 3
Envoyez et créez
Envoyez-le : Ofox Chat rédige le document complet, prêt à télécharger. Continuez la conversation pour le retoucher.
Questions fréquentes
Quel type de fichier vais-je obtenir ?
Un document complet et téléchargeable (Word ou PDF), pas seulement un bloc de texte dans la conversation.
Dois-je préparer quelque chose ?
Non : vous pouvez l’envoyer tel quel et Ofox Chat rédige une première version à partir du modèle. Ajoutez votre contexte, vos données ou des documents existants (collés ou importés en PDF, Word, etc.) et le résultat collera bien mieux à votre situation.
Puis-je modifier le prompt ?
Oui. Le prompt est placé dans la zone de saisie d’Ofox Chat : avant l’envoi, vous pouvez remplacer le sujet par le vôtre, ajouter des exigences ou retirer ce qui ne sert pas.
Puis-je copier et utiliser le prompt directement ?
Oui. Touchez « Copier » sur la carte du prompt pour obtenir le texte brut ; il fonctionne aussi dans d’autres outils de rédaction IA.
Dans le même esprit
Plus de prompts « Ingénierie »- Technical design docExplain how a system or feature will be built—architecture, data model, APIs and alternatives—and assess performance, risks, rollout and rollback.Ingénierie
- API referenceDocument auth, conventions, error codes, and each endpoint's parameters and examples so developers can complete the integration on their own.Ingénierie
- Incident postmortemReconstruct a production incident on a timeline, quantify its impact, trace the root cause, and set owned, dated actions to prevent a repeat.Ingénierie
- Technology evaluationWeigh candidate technologies against criteria set by business needs, score them with evidence, and recommend one with risks and a rollout plan.Ingénierie
- Test planDefine what to test, how, where, and when testing is done for a release or project, aligning QA, engineering and product on expectations.Ingénierie
- Release runbookTurn a deployment into a step-by-step runbook: pre-release checks, numbered steps, post-release verification, and rollback with clear triggers.Ingénierie
- Coding standardsSet shared coding standards: rules ranked must vs. should for naming, structure, error handling, security and reviews, each with examples.Ingénierie
- Database design docDocument the data layer: entity relationships, tables and constraints, the query behind each index, volume estimates and archiving.Ingénierie
- Migration planPlan a system or data migration: inventory, strategy, data sync and validation, phased cutover, and rollback at every stage.Ingénierie
- Performance test reportReport a performance test: throughput, latency percentiles and resource use against targets, the bottlenecks found, and a go/no-go call.Ingénierie
Une idée bien à vous ? Lancez-vous
Décrivez l’image voulue en une phrase, Ofox Chat la crée à partir de zéro.