Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Google Phần Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Thô tục
- Người viết nội dung kỹ thuật:
- Mã Swati Thacker
- Tên dự án:
- Xem lại và cập nhật tài liệu về Người dùng cuối cho Mautic
- Thời lượng dự án:
- Thời lượng tiêu chuẩn (3 tháng)
Mô tả dự án
Ấn tượng đầu tiên của tôi khi xem tài liệu hiện có:
Hiện tại, tài liệu này dài, dư thừa ở nhiều vị trí, không đầy đủ và không gọn gàng, có thể khiến người dùng khó tìm thấy thông tin họ đang tìm kiếm.
Là người dùng lần đầu, tôi không hiểu cách các thành phần của Mautic (chẳng hạn như Chiến dịch, thành phần, thông điệp, danh mục, v.v.) kết hợp với nhau để giải quyết một nhu cầu kinh doanh. Tôi đề xuất có một chủ đề khái niệm cấp cao mô tả mỗi yếu tố Mautic trong 2-3 dòng. Chủ đề này có thể lần lượt liên kết đến nhiều chủ đề chi tiết về nhiệm vụ cho từng yếu tố.
Bạn có thể mở rộng hướng dẫn đóng góp để bổ sung thêm thông tin chẳng hạn như cách mở sự cố, cách đề xuất nội dung/ý tưởng mới, báo cáo lỗi/vấn đề/lỗ hổng bảo mật, v.v. bằng cách cung cấp đường liên kết đến diễn đàn, kênh slack và kho lưu trữ git. Ngoài ra, hướng dẫn quy tắc cần mở rộng để thêm các quy ước, nguyên tắc về kiểu chữ tiêu chuẩn cho hình ảnh, bảng, v.v.
Hơn nữa, có khá nhiều thông tin chưa hoàn tất trong Email, Chiến dịch và thông tin cũ/lỗi thời cần cập nhật.
Lĩnh vực mà tôi muốn đóng góp:
Trong khi thảo luận về các kênh Slack, nơi người dùng tương tác trực tiếp với cộng đồng Mautic, tôi nhận ra rằng Chiến dịch và Email là những yếu tố quan trọng của Mautic. Bằng cách sử dụng Mautibox cho phiên bản 3, tôi đã kiểm tra tài liệu về Chiến dịch và nhận thấy rằng tài liệu này cần được cải tiến kỹ càng. Dưới đây là một số vấn đề tôi đã tìm thấy và đề xuất của tôi cho từng vấn đề:
- Người dùng Mautic có thể chọn trong số nhiều hành động, quyết định và điều kiện trong khi tạo chiến dịch. Nhiều hành động và quyết định bị thiếu tài liệu, mặc dù hầu như không có tài liệu nào về các điều kiện của chiến dịch. Chúng tôi cần xác định và thêm thông tin còn thiếu vào tài liệu của người dùng cuối.
- Chiến dịch có thể đơn giản hoặc cực kỳ phức tạp. Tài liệu hiện tại không cung cấp thêm nhiều giá trị cho những người dùng đang xây dựng chiến dịch lần đầu tiên. Tôi đề xuất xác định một số trường hợp sử dụng (cả đơn giản và phức tạp) và tạo quy trình làm việc mẫu (ở dạng hướng dẫn từng bước hoặc chủ đề trong hướng dẫn người dùng cuối hoặc video hướng dẫn) mà người dùng lần đầu có thể tham khảo trước khi bắt đầu xây dựng chiến dịch của riêng mình.
- Thông tin cần được trình bày theo cách ngăn nắp và có thứ tự hơn trong phần này. Phải tuân theo phương pháp dựa trên nhiệm vụ và khái niệm để tăng khả năng hữu dụng. Các chủ đề có thể sử dụng các bảng để trình bày thông tin về các hành động, quyết định và điều kiện. Chủ đề 'Sử dụng các yếu tố kích hoạt ngày' có vẻ hơi lạc lõng. Nó có thể lồng trong Điều kiện.
Ngoài Chiến dịch, tôi cũng thử nghiệm tài liệu về Email dựa trên giao diện người dùng. Dưới đây là những gì tôi đề xuất thực hiện:
- Bạn có thể sử dụng Nội dung động cho email cho các mẫu email chứa mã tùy chỉnh (dành cho cả email Mẫu và email Phân đoạn) nhưng hiện tại chưa có tài liệu nào về nội dung này. Thêm thông tin chi tiết về chức năng của nội dung động và cách thiết lập loại nội dung đó, cùng một số ví dụ.
- Thêm một chủ đề riêng cho email Giám sát. Điều này có thể bao gồm thông tin về cách sử dụng các tiện ích email có sẵn trên trang tổng quan và cách sử dụng chúng để theo dõi các chỉ số và hoạt động liên quan đến email. Ngoài ra, hãy di chuyển thông tin về email theo dõi vào đây.
- Tài liệu này không nêu rõ rằng thư trả lời liên hệ, quản lý thư trả lại, thư là chủ sở hữu – là các chế độ cài đặt cấu hình chung có thể thiết lập trong phần Cài đặt email. Tất cả các chế độ cài đặt email phải nằm trong một chủ đề chung. Ngoài ra, nhiều chế độ cài đặt email khác như quy tắc tần suất mặc định, chế độ cài đặt huỷ đăng ký cũng không được ghi lại. Nêu các chế độ cài đặt bắt buộc hoặc không bắt buộc.
- Trên trang quản lý Số trang không truy cập, hãy xoá tất cả thông tin về Webhook và đặt thông tin này vào một chủ đề riêng cho Webhook. Sau đó, chúng tôi có thể cung cấp đường liên kết đến chủ đề đó từ đây.
Ngoài ra: - Chủ đề Trang tổng quan không có thông tin đầy đủ về các tiện ích có sẵn. Thông tin này rất quan trọng và cần được thêm vào vì nó giúp người dùng phân tích và giám sát tài nguyên Mautic của họ.
Bạn cần khoanh vùng toàn bộ tài liệu để xác định những thiếu sót. Chúng tôi cần cải tiến để giúp người dùng dễ tiếp cận tài liệu hơn.
Tôi kỳ vọng kiến thức/kinh nghiệm của mình sẽ giúp ích cho dự án này như thế nào?
Sau khi giải quyết các vấn đề khác nhau trong tài liệu Mautic, bao gồm việc thêm khả năng hỗ trợ cho bản phát hành Mautic 3.0 mới nhất trong tháng qua, tôi đã có thể làm quen với cấu trúc của tài liệu dành cho người dùng cuối và cũng xác định được các lỗ hổng trong tài liệu. Tôi đã dành thời gian nghiên cứu tài liệu về các công cụ tự động hoá hoạt động tiếp thị khác và so sánh tài liệu đó với tài liệu dành cho người dùng cuối của Mautic để hiểu cách chúng tôi bổ sung tài liệu còn thiếu trong tài liệu. Tôi đã quen thuộc với ngôn ngữ HTML, các công cụ nguồn mở và các quy trình. Hiện tại, tôi đang tham gia một khoá học về nghiên cứu trải nghiệm người dùng và có thể áp dụng các nguyên tắc này để tạo tài liệu hướng đến người dùng nhiều hơn. Ngoài ra, với kinh nghiệm của mình trong lĩnh vực kiến trúc thông tin, tôi sẽ có thể sắp xếp nội dung và đề xuất ý tưởng để điều chỉnh tài liệu của chúng tôi cho phù hợp với mục tiêu người dùng. Ngoài ra, tôi có mẹo mở rộng kiến thức về các miền kỹ thuật mới. Với 10 năm kinh nghiệm viết nội dung kỹ thuật và kinh nghiệm GSOD trước đó để hoàn thành một dự án cho một tổ chức trong một lĩnh vực kỹ thuật hoàn toàn mới, tôi chắc chắn mình sẽ có thể công bằng để đóng góp cho tài liệu của mình về Mautic.