Mô tả Công việc
Với vai trò là Nhà văn kỹ thuật, bạn sẽ đóng vai trò quan trọng trong việc tạo và duy trì tài liệu sản phẩm toàn diện nhằm hỗ trợ người dùng và nhà phát triển sử dụng hiệu quả các giải pháp phần mềm của chúng tôi. Vị trí này đòi hỏi sự hợp tác với các nhóm liên chức năng để đảm bảo thông tin chính xác và cập nhật được truyền tải thông qua nhiều định dạng, bao gồm hướng dẫn người dùng, hướng dẫn học tập, thông số API và tài liệu SDK. Bạn sẽ làm việc trong môi trường phát triển linh hoạt để đồng bộ tài liệu với các tính năng sản phẩm và nhu cầu người dùng đang phát triển, góp phần vào thành công chung của vòng đời phát triển. Ứng viên lý tưởng cũng sẽ chịu trách nhiệm tổ chức và tập trung hóa thông tin kỹ thuật trong toàn tổ chức, đảm bảo tính nhất quán và khả năng tiếp cận cho tất cả các bên liên quan.
Trách nhiệm Chính
- Viết và duy trì tài liệu sản phẩm, bao gồm sổ tay người dùng, tài liệu tham khảo API và hướng dẫn SDK, đảm bảo tính rõ ràng và khả năng sử dụng cho cả đối tượng kỹ thuật và phi kỹ thuật.
- Phát triển tài liệu hướng dẫn như hướng dẫn học tập và hướng dẫn từng bước để giúp người dùng và nhà phát triển nhanh chóng hiểu và tích hợp với sản phẩm của chúng tôi.
- Hợp tác chặt chẽ với kỹ sư, quản lý sản phẩm và nhóm QA để thu thập yêu cầu, xác thực chi tiết kỹ thuật và đảm bảo tài liệu phản ánh các cập nhật sản phẩm mới nhất.
- Tạo và cập nhật thông số API bằng các công cụ và định dạng tiêu chuẩn ngành, như OpenAPI hoặc Swagger, để hỗ trợ quy trình tích hợp và phát triển.
- Làm việc với các bên liên quan trong tổ chức để thu thập, tổ chức và tập trung hóa thông tin kỹ thuật, duy trì cơ sở kiến thức thống nhất.
- Tiến hành nghiên cứu người dùng để xác định khoảng trống tài liệu và cải thiện trải nghiệm người dùng thông qua các cập nhật nội dung mục tiêu.
- Xem xét và sửa đổi tài liệu hiện có để đảm bảo tính chính xác, nhất quán và phù hợp với tiêu chuẩn công ty và hướng dẫn thương hiệu.
- Tham gia các buổi họp linh hoạt như lập kế hoạch sprint và tổng kết để đảm bảo tài liệu được phát triển theo cách lặp đi lặp lại và đáp ứng thời gian dự án.
- Thiết kế cấu trúc tài liệu trực quan và có thể mở rộng, hỗ trợ cả nhóm nội bộ và khách hàng bên ngoài.
- Đảm bảo tất cả tài liệu được kiểm soát phiên bản, có thể tìm kiếm và truy cập thông qua các nền tảng tập trung như Confluence hoặc cổng thông tin nội bộ.
Yêu cầu Công việc
- Có kinh nghiệm đã được chứng minh với vai trò Nhà văn kỹ thuật hoặc tương tự, với danh mục đầu tư mạnh về các dự án tài liệu kỹ thuật.
- Kỹ năng giao tiếp bằng văn bản và lời nói xuất sắc, với khả năng chuyển đổi các khái niệm kỹ thuật phức tạp thành ngôn ngữ rõ ràng, súc tích.
- Thành thạo các công cụ tài liệu như Markdown, Confluence và hệ thống kiểm soát phiên bản như Git.
- Hiểu biết vững chắc về nguyên tắc thiết kế API và khả năng tạo thông số chi tiết cho dịch vụ RESTful và SDK.
- Khả năng làm việc độc lập và hợp tác trong môi trường linh hoạt nhịp độ nhanh, đáp ứng thời hạn chặt chẽ mà không ảnh hưởng đến chất lượng.
- Hiểu biết về phương pháp luận thiết kế hướng người dùng và khả năng tạo tài liệu nâng cao trải nghiệm và mức độ áp dụng của người dùng.
- Chú ý đến chi tiết và cam kết về độ chính xác, đảm bảo tất cả thông tin kỹ thuật được thể hiện đúng trong tài liệu.
- Kinh nghiệm với các khung tài liệu và công cụ hỗ trợ tạo tự động, như Swagger hoặc API Blueprint.
- Khả năng tiến hành phỏng vấn hoặc hợp tác với các nhóm kỹ thuật để thu thập yêu cầu và làm rõ các khái niệm phức tạp.
- Kỹ năng tổ chức xuất sắc, với khả năng quản lý nhiều dự án tài liệu đồng thời và ưu tiên công việc hiệu quả.
- Hiểu biết vững chắc về vòng đời phát triển phần mềm và khả năng đồng bộ tài liệu với các bản phát hành và cập nhật sản phẩm.
- Khả năng tạo và duy trì mẫu tài liệu đảm bảo tính nhất quán trên tất cả tài liệu sản phẩm.
- Kinh nghiệm với hệ thống quản lý nội dung và khả năng xuất bản tài liệu lên các nền tảng nội bộ và bên ngoài.
- Kỹ năng giải quyết vấn đề xuất sắc, với khả năng xác định thách thức tài liệu và đề xuất giải pháp sáng tạo.
- Khả năng làm việc với sự giám sát tối thiểu, chịu trách nhiệm về các sản phẩm tài liệu và đảm bảo hoàn thành đúng hạn.
- Hiểu biết về tiêu chuẩn tiếp cận và khả năng tạo tài liệu bao trùm đáp ứng yêu cầu quy định.
- Kỹ năng hợp tác mạnh mẽ, với khả năng làm việc hiệu quả với các nhóm liên chức năng và các bên liên quan.
- Kinh nghiệm với việc bản địa hóa và dịch thuật tài liệu cho đối tượng toàn cầu, nếu có.
- Khả năng cung cấp phản hồi về quy trình tài liệu và đóng góp vào các sáng kiến cải tiến liên tục.
- Kỹ năng quản lý thời gian xuất sắc, với khả năng đáp ứng thời hạn dự án trong khi duy trì tiêu chuẩn tài liệu chất lượng cao.