Mô tả Công việc
Trách nhiệm Chính
- Phát triển và duy trì tài liệu kỹ thuật chất lượng cao phù hợp với mục tiêu sản phẩm và nhu cầu người dùng
- Phối hợp với nhóm kỹ thuật xây dựng tài liệu tham khảo API chi tiết, sơ đồ kiến trúc hệ thống và hướng dẫn triển khai
- Làm việc cùng quản lý sản phẩm để sản xuất sổ tay người dùng, hướng dẫn và tài liệu đào tạo cho cả người dùng mới và nâng cao
- Hợp tác với nhóm nghiên cứu để ghi chép các đổi mới kỹ thuật, sách trắng và kết quả thử nghiệm
- Thiết kế khung tài liệu tối ưu hóa kiến trúc thông tin và điều hướng người dùng
- Triển khai hệ thống quản lý nội dung để tổ chức tài liệu trên nhiều nền tảng và kho lưu trữ
- Thực hiện kiểm tra tài liệu định kỳ đánh giá tính rõ ràng, đầy đủ và phù hợp
- Xây dựng chiến lược nội dung cân bằng giữa độ chính xác kỹ thuật và giải thích thân thiện với người dùng
- Phối hợp với nhóm tiếp thị tạo nội dung quảng bá và nghiên cứu điển hình kỹ thuật
- Đảm bảo tài liệu được bản địa hóa và điều chỉnh cho đối tượng toàn cầu với trình độ kỹ thuật đa dạng
Yêu cầu Công việc
- Kinh nghiệm chứng minh trong vai trò viết tài liệu kỹ thuật, tập trung vào tài liệu phần mềm và phát triển API
- Hiểu biết sâu về nguyên tắc viết kỹ thuật, bao gồm tiêu chuẩn và phương pháp tài liệu tốt nhất
- Kỹ năng giao tiếp xuất sắc để chuyển đổi thuật ngữ kỹ thuật thành ngôn ngữ dễ tiếp cận cho đối tượng phi kỹ thuật
- Thành thạo công cụ tạo nội dung như MadCap Flare, Confluence và trình soạn thảo Markdown
- Khả năng làm việc độc lập trong khi duy trì hợp tác với các nhóm liên chức năng
- Kinh nghiệm với hệ thống kiểm soát phiên bản như Git để quản lý cập nhật tài liệu
- Hiểu biết về quản lý vòng đời tài liệu và kỹ thuật tối ưu hóa phân phối nội dung
- Kỹ năng phân tích mạnh để đánh giá hiệu quả tài liệu thông qua số liệu người dùng và phản hồi
- Khả năng tạo yếu tố tài liệu trực quan như sơ đồ, lưu đồ và mô phỏng giao diện
- Kỹ năng tổ chức xuất sắc để quản lý dự án tài liệu trên nhiều sản phẩm và nền tảng
- Thành thạo đa ngôn ngữ để tạo nội dung tài liệu bản địa hóa
- Kinh nghiệm với công cụ bản địa hóa nội dung và hệ thống quản lý dịch thuật
- Khả năng phát triển mẫu tài liệu đảm bảo tính nhất quán trên tất cả đầu ra
- Chú ý chi tiết cao để duy trì độ chính xác kỹ thuật và tiêu chuẩn chất lượng tài liệu
Đánh giá Tài liệu
Liên tục đánh giá hiệu quả tài liệu thông qua số liệu tương tác người dùng, khảo sát phản hồi và công cụ phân tích. Xác định khoảng trống kiến thức và lĩnh vực cần cải thiện bằng cách phân tích mẫu hành vi người dùng và thống kê sử dụng tài liệu. Phát triển kế hoạch cải tiến giải quyết các vấn đề về độ chính xác kỹ thuật, khả năng sử dụng và tính đầy đủ nội dung. Triển khai cập nhật tài liệu lặp đi lặp lại dựa trên ý kiến bên liên quan và nhu cầu người dùng. Theo dõi hiệu suất tài liệu trên các nền tảng và đối tượng khác nhau để đảm bảo trải nghiệm người dùng tối ưu và khả năng tiếp cận thông tin.
Nâng cao Chất lượng Nội dung
Tăng cường chất lượng tài liệu bằng cách thực hiện nghiên cứu kỹ thuật chuyên sâu và hợp tác với chuyên gia chủ đề. Phát triển nội dung cân bằng giữa chiều sâu kỹ thuật và khả năng hiểu của người dùng thông qua giải thích có cấu trúc và công cụ trực quan. Đảm bảo tài liệu phản ánh các cập nhật sản phẩm mới nhất và tiến bộ kỹ thuật thông qua đánh giá nội dung định kỳ và kiểm soát phiên bản. Tạo tài liệu hỗ trợ cả quy trình phát triển và ứng dụng người dùng cuối thông qua hướng dẫn toàn diện và tài liệu tham khảo. Duy trì tiêu chuẩn tài liệu đảm bảo tính nhất quán, chính xác và rõ ràng trên tất cả đầu ra.
Định dạng Phân phối Nội dung
Phân phối tài liệu ở nhiều định dạng bao gồm nội dung viết, hướng dẫn video, hướng dẫn tương tác và kho lưu trữ mã công khai. Phát triển nội dung được tối ưu hóa cho các phương tiện khác nhau như web, bản in và nền tảng kỹ thuật số. Đảm bảo tài liệu có thể truy cập qua nhiều kênh bao gồm cổng nhà phát triển, diễn đàn cộng đồng và trang web sản phẩm. Tạo nội dung hỗ trợ các phong cách học tập khác nhau thông qua tài liệu dạng văn bản, tài liệu nghe nhìn và ví dụ mã. Phát triển tài liệu dễ dàng tìm kiếm và điều hướng thông qua lập chỉ mục và triển khai siêu dữ liệu phù hợp.
Giao tiếp Bên liên quan
Cung cấp cập nhật thường xuyên cho các bên liên quan dự án và quản lý về tiến độ tài liệu, thách thức và chiến lược giải quyết. Phát triển kế hoạch giao tiếp đảm bảo tính minh bạch trong phát triển và phân phối tài liệu. Phối hợp với các nhóm liên chức năng để giải quyết các vấn đề liên quan đến tài liệu và căn chỉnh nội dung với lộ trình sản phẩm. Duy trì báo cáo trạng thái tài liệu theo dõi tiến độ so với cột mốc dự án và tiêu chuẩn chất lượng. Đảm bảo đầu ra tài liệu đáp ứng kỳ vọng bên liên quan thông qua phản hồi liên tục và cải tiến lặp đi lặp lại. Phát triển chiến lược tài liệu phù hợp với mục tiêu tổ chức và yêu cầu người dùng.