Tạo hướng dẫn setup môi trường dev cho dự án fullstack

Lượt xem 31
AI sử dụng
ChatGPT Gemini Claude

Mục tiêu

Bộ prompt giúp bạn tạo ra tài liệu hướng dẫn setup môi trường phát triển (development environment) hoàn chỉnh cho dự án fullstack. Tài liệu sinh ra có cấu trúc chuyên nghiệp, dễ theo dõi và phù hợp để chia sẻ trong team hoặc đưa vào repository.

  • Tạo hướng dẫn từng bước cài đặt dependencies, runtime, database và công cụ hỗ trợ.
  • Sinh nội dung cấu hình biến môi trường (.env) với giải thích từng key.
  • Bao gồm phần xử lý lỗi thường gặp khi setup lần đầu.
  • Tùy biến theo tech stack, hệ điều hành và trình độ của người đọc.

Khi nào nên dùng

  • Onboard thành viên mới vào dự án và cần tài liệu setup nhanh.
  • Chuẩn hóa quy trình setup để tránh lỗi môi trường giữa các máy trong team.
  • Viết README.md hoặc tài liệu kỹ thuật cho dự án open source hoặc nội bộ.
  • Tạo checklist kiểm tra trước khi bắt đầu phát triển tính năng mới.

Hướng dẫn tùy biến

Trước khi dùng prompt, hãy thay thế các placeholder trong dấu ngoặc vuông bằng thông tin thực tế của dự án:

  1. [TÊN DỰ ÁN]: Tên dự án của bạn.
  2. [TECH STACK]: Ví dụ: Next.js 14, NestJS, PostgreSQL, Redis, Docker.
  3. [HỆ ĐIỀU HÀNH]: macOS, Windows 11, Ubuntu 22.04 hoặc tất cả.
  4. [ĐỐI TƯỢNG]: Junior dev, senior dev, hoặc người không chuyên kỹ thuật.
  5. [ĐỊNH DẠNG ĐẦU RA]: Markdown cho README, plain text cho Confluence, hoặc HTML.

Lưu ý

  • Kiểm tra lại các lệnh terminal do AI sinh ra trước khi đưa vào tài liệu chính thức, đặc biệt với các phiên bản package cụ thể.
  • Với dự án có nhiều service (microservices), nên dùng biến thể prompt theo từng service thay vì gộp chung.
  • Nếu dự án dùng Docker Compose, hãy yêu cầu AI bổ sung phần hướng dẫn chạy toàn bộ stack bằng một lệnh duy nhất.
  • Tài liệu nên được cập nhật mỗi khi có thay đổi lớn về dependencies hoặc cấu hình.

Nội dung Prompt

Bạn cần đăng nhập để xem đầy đủ nội dung Prompt.

Có thể bạn quan tâm

Sản phẩm nổi bật