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 Phần Google Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Mautic
- Người viết nội dung kỹ thuật:
- Tàm swati
- Tên dự án:
- Xem lại và cập nhật tài liệu về Người dùng cuối của Mautic
- Thời lượng dự án:
- Thời gian 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, bị thừa ở nhiều nơi, chưa hoàn chỉnh và thiếu thứ tự. Điều này có thể khiến người dùng khó tìm thấy thông tin họ cần.
Vì là người mới dùng lần đầu nên 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ể liên kết đến nhiều chủ đề nhiệm vụ chi tiết cho từng yếu tố trong số đó.
Bạn có thể mở rộng hướng dẫn đóng góp để bổ sung thêm thông tin (ví dụ: cách mở vấn đề, 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 phụ và kho lưu trữ git. Ngoài ra, hướng dẫn quy tắc cần mở rộng để thêm quy ước kiểu chữ chuẩn, nguyên tắc về hình ảnh, bảng, v.v.
Hơn nữa, có khá nhiều thông tin chưa hoàn chỉnh 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 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à hai yếu tố tối 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 mạnh mẽ. 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. Thiếu tài liệu 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 tôi cần xác định và thêm thông tin còn thiếu vào tài liệu 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 bổ sung nhiều giá trị cho những người dùng tạo 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ưới dạng hướng dẫn từng bước hoặc cá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 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 được sắp xếp và có thứ tự hơn trong phần này. Phải tuân thủ nhiệm vụ và cách tiếp cận dựa trên khái niệm để tăng khả năng hữu dụng. Các chủ đề này 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 các yếu tố kích hoạt ngày" có vẻ hơi không phù hợp. Ứng dụng có thể lồng trong Điều kiện.
Ngoài Chiến dịch, tôi cũng đã kiểm tra 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:
- Nội dung động cho email hiện có sẵn cho các mẫu email chứa mã tuỳ chỉnh (dành cho cả email Mẫu và email Phân đoạn) nhưng hiện chưa có tài liệu nào cho loại email 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 này cùng một số ví dụ.
- Thêm một chủ đề riêng cho email Giám sát. Phần 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 cũng như 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ề các 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ả về, thư là chủ sở hữu. Đây là các chế độ cài đặt cấu hình chung có thể được định cấu hình trong phần Cài đặt email. Tất cả chế độ cài đặt Email phải nằm trong một chủ đề bao quát. 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. Đề cập đến những 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 có thông tin chưa đầ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 thu thập 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 để người dùng dễ tiếp cận tài liệu này hơn.
Tôi kỳ vọng kiến thức/kinh nghiệm của mình sẽ có í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 về Mautic, bao gồm cả việc thêm hỗ trợ cho bản phát hành Mautic 3.0 mới nhất trong tháng qua, tôi đã có thể tự làm quen với cấu trúc của tài liệu 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 tìm hiể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 về người dùng cuối của Mautic để hiểu cách chúng tôi có thể bổ sung những công cụ còn thiếu đó trong tài liệu của mình. Việc quen thuộc của tôi với ngôn ngữ HTML, các công cụ nguồn mở và quy trình là một lợi thế lớn. 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 để 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 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 người dùng. Ngoài ra, tôi còn 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 trước đó tại GSOD để hoàn thành thành công một dự án cho một tổ chức thuộc lĩnh vực kỹ thuật hoàn toàn mới, tôi chắc chắn mình sẽ có thể xứng đáng với sự đóng góp của mình cho tài liệu của Mautic.