Viết tài liệu kỹ thuật để 6 tháng sau còn đọc được

Tài liệu tốt trả lời được “vì sao” chứ không chỉ “cái gì”.
Viết tài liệu kỹ thuật để 6 tháng sau còn đọc được

Mỗi dự án nên có:

  • Hướng dẫn chạy từ máy trống.
  • Sơ đồ kiến trúc một trang.
  • Các quyết định quan trọng kèm lý do.
  • Danh sách việc dễ sai.

Viết ngắn, có ví dụ, để cạnh mã nguồn và cập nhật cùng lúc với mã.

Chia sẻ
Facebook
Zalo

Góp ý cho bài viết

Góp ý của bạn được gửi riêng cho tác giả và không hiển thị công khai.

0/2000
Được phát triển bởi Cloudzone