Dự án Mautic

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:
Ưu tiên Kelvin
Tên dự án:
Cơ sở kiến thức
Thời lượng dự án:
Thời gian 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 thông tin được lưu trữ, sắp xếp và chia sẻ. Khi được sử dụng bên ngoài, cơ sở kiến thức là nơi người dùng có thể tìm hiểu mọi thứ họ cần phải 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ở kiến thức nội bộ thường được sử dụng như một cách để cho phép cộng đồng/người dùng cộng tác và phân phối toàn bộ 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ể thay đổi dựa trên nhiều yếu tố, nhưng hầu hết thường bao gồm thông tin về cách bắt đầu sử dụng một số sản phẩm, khai thác nhiều hơn các tính năng nâng cao và khắc phục các vấn đề hoặc vấn đề phổ biến. Lợi ích chính của việc tạo và trình bày cơ sở kiến thức cho độc giả là bạn có thể cung cấp thông tin chuyên sâu, ngay lập tức, theo yêu cầu và câu trả lời cho thành viên/người dùng/cộng đồng độc giả mà không cần phải thực hiện việc này riêng lẻ.

Mautic Knowledgebase là kho lưu trữ trung tâm dành cho các video hướng dẫn, chỉ dẫn thực hiện và các phương pháp hay nhất về các chủ đề liên quan đến Mautic, cho dù là trực tiếp (ví dụ: cách thực hiện mọi việc ở Mautic) hay gián tiếp (ví dụ: các chiến lược tiếp thị tổng quát hơn).

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

Ấn tượng đầu tiên của tôi khi xem tài liệu hiện có Hiện tại, Cơ sở kiến thức của Mautic có sẵn https://kb.mautic.org/. Một số bài hướng dẫn và chỉ dẫn cách làm cũng như các chủ đề về các phương pháp hay nhất trong tài liệu này chưa được cập nhật và cung cấp nội dung thưa thớt hoặc không đầy đủ, đồng thời 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 bạn lại đề xuất những điểm cải thiện so với một/khía cạnh hiện tại mà tôi muốn đóng góp? Cải tiến được đề xuất nhằm cải thiện và đảm bảo hiệu quả, tính nhất quán và sự an tâm cho bất kỳ người dùng cuối nào. Cuốn sách này có các tài liệu hướng dẫn bằng văn bản, chỉ dẫn cách làm, các phương pháp hay nhất và hình ảnh kèm theo, đồng thời cung cấp các chỉ dẫn và giải thích về cách sử dụng từng tính năng của ma thuật, mới nhất, dễ thao tác và dễ hiểu.

Phân tích

Mautic Knowledgebase được viết bằng CMS tệp phẳng Grav và giao diện KLB4. Tôi đã nghiên cứu nhiều 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 video hướng dẫn và chỉ dẫn cách thực hiện cho 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ộng đồng Mautic mới tạo
  • Viết một loạt các hướng dẫn cách sử dụng để giúp người dùng Mautic thiết lập, định cấu hình và sử dụng ứng dụng một cách hiệu quả hơn.
  • Cập nhật hướng dẫn bằng video 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 quy tắc/mẫu của tài liệu cơ sở kiến thức

Lịch trình

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

  • Tiếp tục đóng góp cho tổ chức.
  • Trở nên quen thuộc 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 để giúp ích khi triển khai dự án.

Gắn kết cộng đồng (1 tháng 8 – 1 tháng 9)

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

Khoảng thời gian ghi nhận tài liệu

  • Tuần 1 (2/9 – 22/11)
  • Trong những khoảng thời gian này, tôi sẽ làm việc trực tiếp với những người cố vấn của mình để :
  • Xem lại cơ sở kiến thức.
  • Cập nhật video hướng dẫn và chỉ dẫn cách thực hiện cho 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ộng đồng Mautic mới tạo
  • Viết một loạt các hướng dẫn cách sử dụng để giúp người dùng Mautic thiết lập, định cấu hình và sử dụng ứng dụng một cách hiệu quả hơn.
  • Cập nhật hướng dẫn bằng video 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 quy tắc/mẫu 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 nhà phát triển bận rộn với các bản phát hành tính năng nhỏ

Đánh giá dự án (25/11 – 29/11/2019)

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