Điểm:-2

Làm cách nào để tự động tạo tài liệu cho trang web của tôi?

lá cờ hk

Tôi đang làm việc trên một trang web Drupal phức tạp với nhiều mô-đun tùy chỉnh, thực thể tùy chỉnh, lớp tùy chỉnh, chế độ xem tùy chỉnh, sự kiện tùy chỉnh, người đăng ký sự kiện tùy chỉnh, biểu mẫu tùy chỉnh, bộ điều khiển tùy chỉnh. Nói tóm lại, rất nhiều mã tùy chỉnh.

Đó là một thách thức lớn khi cố gắng cập nhật tài liệu kỹ thuật cho hệ thống khi chúng tôi liên tục thực hiện các thay đổi đối với ứng dụng.

Có cách nào để tự động tạo tài liệu kỹ thuật cho trang web không? Ví dụ.

Một mô-đun được sử dụng cho x, y, z Chế độ xem V được sử dụng cho những thứ như vậy, các khối chế độ xem đang được sử dụng trong các trang như vậy. Loại nội dung C được sử dụng cho l, m, n và được sử dụng trong các khung nhìn V1, V2, V3.

Nếu không hoàn toàn tự động, ít nhất một phần và có cơ chế nào đó để thêm các mục còn lại theo cách thủ công?

Chỉnh sửa: Cảm ơn về mẹo về mô-đun API @cilefen. Đó dường như là một cách hay để tạo tài liệu về mã tùy chỉnh. Tuy nhiên, có những phần cũng là một phần của cấu hình - như chế độ xem, bố cục, khối, v.v. Điều đó sẽ không được ghi lại bằng mô-đun API.

Điểm:1
lá cờ id

Sử dụng mô-đun API để tạo tài liệu từ mã. Doxygen hoặc phpDocumentor cũng có thể phù hợp với bạn, tùy thuộc vào nhu cầu của bạn.

Jaypan avatar
lá cờ de
Tôi thứ hai mô-đun API.
lá cờ hk
Cảm ơn về mẹo trên mô-đun API. Đó là một lựa chọn thú vị. Làm cách nào để bạn ghi lại các dạng xem, bố cục, loại nội dung và các mục khác là một phần của cấu hình?
lá cờ id
Đó cũng là mô-đun API. Xem xét bất kỳ tệp *.api.php nào trong Drupal tạo các trang trên trang web API. Hiện chúng ta đang đi vào lãnh thổ ý kiến, nhưng https://www.mkdocs.org cũng đơn giản và dễ sử dụng cho tài liệu đặc biệt.

Đăng câu trả lời

Hầu hết mọi người không hiểu rằng việc đặt nhiều câu hỏi sẽ mở ra cơ hội học hỏi và cải thiện mối quan hệ giữa các cá nhân. Ví dụ, trong các nghiên cứu của Alison, mặc dù mọi người có thể nhớ chính xác có bao nhiêu câu hỏi đã được đặt ra trong các cuộc trò chuyện của họ, nhưng họ không trực giác nhận ra mối liên hệ giữa câu hỏi và sự yêu thích. Qua bốn nghiên cứu, trong đó những người tham gia tự tham gia vào các cuộc trò chuyện hoặc đọc bản ghi lại các cuộc trò chuyện của người khác, mọi người có xu hướng không nhận ra rằng việc đặt câu hỏi sẽ ảnh hưởng—hoặc đã ảnh hưởng—mức độ thân thiện giữa những người đối thoại.