Chúng tôi đã thiếu tài liệu trong khi phát triển các chủ đề hoặc plugin cho Opencart nhưng đã tìm thấy PHPDoc giúp chúng tôi ghi lại các dự án PHP của mình một cách dễ dàng. Một lập trình viên giỏi chịu trách nhiệm giao tiếp với các lập trình viên khác phải hỗ trợ tài liệu. Bất cứ khi nào chúng tôi viết mã, chúng tôi bắt đầu nghĩ đến 5W và viết từng cái để có tài liệu tốt hơn
5Ws để có tài liệu tốt hơn
Điều gì, khi nào, ở đâu, như thế nào và tại sao nên được trả lời trong khi tạo tài liệu tốt hơn. Chúng tôi đã đưa ra những ý tưởng sau đây để liệt kê trong tài liệu của chúng tôi. Đó chỉ là ý tưởng của chúng tôi, của bạn có thể hoàn toàn khác
Gì. Tuyên bố quyền lực
“Cái gì” sẽ là tiêu đề, bao gồm Tiêu đề sự cố, tiêu đề Bước, Tiêu đề tính năng mới, tiêu đề chức năng, v.v.
Khi nào và ở đâu. Sự mô tả
“Khi nào và ở đâu” sẽ được đưa vào phần mô tả. Mô tả sẽ bao gồm
- Một đoạn trích mà bạn có thể viết
- Công cụ/Trang web/Tên mẫu/Tên plugin
- Bao gồm liên kết Vé
- Liên kết mã Github
Tại sao. Mã và logic được triển khai
Trong phần “Tại sao”, chúng tôi thêm mã và logic
Làm sao. Kiểm tra đầu ra/Báo cáo/Số liệu
Trong phần “Làm thế nào”, chúng tôi thêm đầu ra, thử nghiệm, báo cáo và chỉ số