Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Mautic
- Người viết nội dung kỹ thuật:
- Swati Thacker
- Tên dự án:
- Xem lại và cập nhật tài liệu dành cho người dùng cuối về Mautic
- Thời lượng dự án:
- Thời hạn 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, thừa thãi ở nhiều nơi, không đầy đủ và lộn xộn, có thể khiến người dùng khó tìm thấy thông tin họ cần.
Vì là người dùng lần đầu tiên, nên tôi không hiểu được cách các yếu tố 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 một chủ đề khái niệm cấp cao mô tả từng phần tử Mautic trong 2-3 dòng. Chủ đề này có thể liên kết đến nhiều chủ đề công việc chi tiết cho từng phần tử trong số này.
Bạn có thể mở rộng hướng dẫn đóng góp để cung cấp thêm thông tin, chẳng hạn như cách mở vấn đề, cách đề xuất nội dung/ý tưởng mới, cách 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, bản hướng dẫn phong cách cần mở rộng để thêm các quy ước kiểu chữ tiêu chuẩn, nguyên tắc về hình ảnh, bảng, v.v.
Ngoài ra, có khá nhiều thông tin chưa đầy đủ trong Email, Chiến dịch và thông tin cũ/hết hạn cần cập nhật.
Lĩnh vực mà tôi muốn đóng góp:
Trong khi xem xét các cuộc thảo luận trên 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 thấy rằng Chiến dịch và Email là những thành phần quan trọng của Mautic. Khi sử dụng Mautibox cho phiên bản 3, tôi đã kiểm thử tài liệu về Chiến dịch và nhận thấy tài liệu này cần được cải tiến đáng kể. Sau đây là một số vấn đề tôi phát hiện được 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. Tài liệu này thiếu thông tin về nhiều hành động và quyết định, trong khi 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 ta cần xác định và thêm thông tin còn thiếu vào tài liệu dành cho người dùng cuối.
- Chiến dịch có thể đơn giản hoặc rất phức tạp. Tài liệu hiện tại không mang lại nhiều giá trị cho những người dùng lần đầu tạo chiến dịch. Bạn nên 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ưới dạng hướng dẫn từng bước hoặc chủ đề trong hướng dẫn cho 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 tạo chiến dịch của riêng họ.
- Thông tin cần được trình bày theo cách có tổ chức và trật tự hơn trong phần này. Phải tuân theo cách tiếp cận 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 bảng để trình bày thông tin về hành động, quyết định và điều kiện. Chủ đề "Sử dụng điều kiện kích hoạt theo ngày" có vẻ hơi lạc đề. Bạn có thể lồng điều kiện này trong phần Điều kiện.
Ngoài chiến dịch, tôi cũng kiểm thử tài liệu về Email so với giao diện người dùng. Sau đây là những việc tôi đề xuất nên làm:
- Nội dung động cho email có sẵn cho mẫu email mã tuỳ chỉnh (dành cho cả email Mẫu và email Phân đoạn) nhưng hiện tại, chúng tôi chưa có tài liệu 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 nội dung động, cùng với một vài ví dụ.
- Thêm một chủ đề riêng cho tính năng Theo dõi email. Thông tin 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 các tiện ích đó để 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ề theo dõi email vào đây.
- Tài liệu không nêu rõ rằng thư trả lời liên hệ, quản lý thư trả lại, trình gửi thư là chủ sở hữu - là các cài đặt cấu hình chung có thể được định cấu hình trong Cài đặt email. Tất 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ý đều không được ghi lại. Đề cập đến chế độ cài đặt nào là bắt buộc hoặc không bắt buộc.
- Trên trang Quản lý lượt thoát, hãy xoá tất cả thông tin về Webhook và đặt thông tin đó 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 có thông tin chưa đầy đủ về các tiện ích hiện có. Đây là thông tin quan trọng và cần được thêm vào vì giúp người dùng phân tích và theo dõi các tài nguyên Mautic của họ.
Cần phải tổng hợp toàn bộ tài liệu để xác định các lỗ hổng. Chúng ta cần cải tiến để người dùng dễ tiếp cận tài liệu hơn.
Tôi dự kiến kiến thức/kinh nghiệm của mình sẽ mang lại lợi ích gì cho dự án này?
Sau khi xử lý nhiều vấn đề trong tài liệu Mautic, bao gồm cả việc hỗ trợ thêm 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 những thiếu sót 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á 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 có thể bổ sung thông tin còn thiếu trong tài liệu của mình. Tôi cũng có lợi thế là đã quen thuộc với ngôn ngữ HTML, các công cụ và quy trình nguồn mở. Tôi hiện đang theo học 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 phù hợp hơn với người dùng. Ngoài ra, với kinh nghiệm về 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 cho phù hợp với mục tiêu của người dùng. Ngoài ra, tôi còn có sở trường để mở rộng kiến thức về các lĩnh vực kỹ thuật mới. Với 10 năm kinh nghiệm viết tài liệu kỹ thuật và kinh nghiệm GSOD trước đây khi hoàn thành thành công 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 đối với tôi, tôi chắc chắn rằng mình sẽ có thể đóng góp xứng đáng cho tài liệu Mautic.