Dự án Mautic

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
Tác giả kỹ thuật:
Ưu tiên Kelvin
Tên dự án:
Knowledgebase
Thời lượng dự án:
Thời hạn tiêu chuẩn (3 tháng)

Mô tả dự án

Bản tóm tắt

Cơ sở kiến thức là một kho lưu trữ tập trung, nơi lưu trữ, sắp xếp và chia sẻ thông tin. Khi được sử dụng bên ngoài, cơ sở kiến thức là nơi người dùng có thể truy cập để tìm hiểu mọi thông tin họ cần biết về sản phẩm hoặc dịch vụ, tổ chức và ngành của một công ty. Mặt khác, cơ sở tri thức nội bộ thường được sử dụng để cho phép cộng đồng/người dùng cộng tác và phân phối tất cả kiến thức và thông tin của công ty trong nội bộ. Mặc dù nội dung của các cơ sở kiến thức cụ thể khác nhau tuỳ theo nhiều yếu tố, nhưng thường bao gồm thông tin về cách bắt đầu sử dụng các sản phẩm cụ thể, khai thác hiệu quả hơn các tính năng nâng cao và khắc phục các vấn đề thường gặp. Lợi ích chính của việc tạo và trình bày cơ sở kiến thức cho đối tượng là nó cho phép bạn cung cấp thông tin chuyên sâu, tức thì, theo yêu cầu và có câu trả lời cho thành viên/người dùng/cộng đồng của độc giả mà không cần phải thực hiện riêng từng người.

Cơ sở kiến thức của Mautic là kho lưu trữ trung tâm cho các hướng dẫn, hướng dẫn cách thực hiện và các phương pháp hay nhất về các chủ đề liên quan đến Mautic – dù là trực tiếp (ví dụ: cách thực hiện các thao tác trong Mautic) hay gián tiếp (ví dụ: các chiến lược tiếp thị chung hơn).

Tại thời điểm viết bài này, Cơ sở kiến thức Mautic còn khá mới và chưa hoàn chỉnh. Cộng đồng Mautic muốn sử dụng dự án này để cải thiện cách cung cấp thông tin chuyên sâu và thông tin theo yêu cầu cho tài liệu của người dùng nhằm mang lại trải nghiệm liền mạch cho người dùng cuối khi sử dụng Mautic. Việc xem qua Cơ sở kiến thức của Mautic khá hữu ích nhưng cần có các hướng dẫn và hướng dẫn mới nhất để tạo các hướng dẫn mới cũng như phù hợp với phiên bản Mautic 3x.

Ấn tượng ban đầu của tôi khi xem tài liệu hiện có Hiện tại, bạn có thể truy cập vào Cơ sở kiến thức của Mautic https://kb.mautic.org/. Một số nội dung hướng dẫn, hướng dẫn cách thực hiện và các phương pháp hay nhất trong tài liệu không cập nhật và chưa đầy đủ hoặc thưa thớt và cũng không bao gồm thông tin về phiên bản hiện tại của mautic.

Tại sao đề xuất cải tiến của bạn tốt hơn đề xuất cải tiến hiện tại/các khía cạnh mà tôi muốn đóng góp? Mục đích của điểm cải tiến được đề xuất là cải thiện và đảm bảo hiệu quả, tính nhất quán và sự an tâm cho mọi người dùng cuối. Tài liệu này sẽ chứa hướng dẫn bằng văn bản, hướng dẫn cách thực hiện và các phương pháp hay nhất cùng với hình ảnh liên quan, bao gồm hướng dẫn và giải thích về cách sử dụng từng tính năng của mautic, được cập nhật, dễ thao tác và dễ hiểu.

Phân tích

Cơ sở kiến thức Mautic được viết bằng CMS tệp phẳng Grav và giao diện KLB4. Tôi đã nghiên cứu rất nhiều về cách cải thiện tài liệu cơ sở kiến thức

Mục tiêu dự án

  • Xem lại cơ sở kiến thức.
  • Cập nhật các video hướng dẫn và chỉ dẫn phù hợp với phiên bản Mautic 3x.
  • Tạo tài nguyên cho Cơ sở kiến thức của Cộng đồng Mautic mới thành lập
  • Viết một loạt hướng dẫn và hướng dẫn cách thực hiện để giúp người dùng Mautic thiết lập, định cấu hình và sử dụng ứng dụng hiệu quả hơn.
  • Cập nhật video hướng dẫn cho phù hợp với phiên bản Mautic 3x.
  • Xoá hình ảnh và thông tin lỗi thời.
  • Viết lại cơ sở kiến thức để dễ hiểu hơn.
  • Đảm bảo triển khai đúng cách hướng dẫn/mẫu về văn phong của tài liệu cơ sở kiến thức

Dòng thời gian

Trước ngày 1 tháng 8

  • Tiếp tục đóng góp cho tổ chức.
  • Làm quen hơn với tài liệu cơ sở kiến thức và phiên bản hiện tại của Mautic.
  • Tìm hiểu các kỹ thuật mới và kỹ năng viết kỹ thuật sẽ hữu ích trong quá trình triển khai dự án.

Kết nối cộng đồng (1/8 – 1/9)

  • Thiết lập kênh và thời gian liên lạc (do chênh lệch múi giờ)
  • Tinh chỉnh mục tiêu và đặt kỳ vọng cho cả hai bên
  • Tìm hiểu thêm về cộng đồng và sản phẩm
  • Thảo luận với người cố vấn và các thành viên khác của tổ chức cấu trúc tài liệu được đề xuất.
  • Hoàn thiện các tính năng được đề xuất và những nội dung sửa đổi khác cần thực hiện đối với tài liệu hiện có.

Thời gian ghi nhận

  • Tuần 1 (2 tháng 9 – 22 tháng 11)
  • Trong những khoảng thời gian này, tôi sẽ làm việc trực tiếp với các cố vấn để :
  • Xem lại cơ sở kiến thức.
  • Cập nhật các video hướng dẫn và chỉ dẫn phù hợp với phiên bản Mautic 3x.
  • Tạo tài nguyên cho Cơ sở kiến thức của Cộng đồng Mautic mới thành lập
  • Viết một loạt hướng dẫn và hướng dẫn cách thực hiện để giúp người dùng Mautic thiết lập, định cấu hình và sử dụng ứng dụng hiệu quả hơn.
  • Cập nhật video hướng dẫn cho phù hợp với phiên bản Mautic 3x.
  • Xoá hình ảnh và thông tin lỗi thời.
  • Viết lại cơ sở kiến thức cho dễ hiểu hơn.
  • Đảm bảo triển khai đúng cách hướng dẫn/mẫu về văn phong của tài liệu cơ sở kiến thức.
  • Cân nhắc tần suất phát hành vì nhóm phát triển sẽ bận rộn với các bản phát hành tính năng nhỏ

Đánh giá dự án (từ ngày 25 tháng 11 đến ngày 29 tháng 11 năm 2019)

  • Gửi báo cáo dự án và bản đánh giá của người cố vấn
  • Viết và gửi báo cáo về trải nghiệm của tôi khi tham gia Chương trình mùa tài liệu.