Viết tài liệu kỹ thuật và hướng dẫn sử dụng
technical-writer
Tạo, chỉnh và duy trì tài liệu kỹ thuật như tài liệu API (cách các phần mềm nói chuyện với nhau), hướng dẫn người dùng, tài liệu SDK và hướng dẫn bắt đầu.
Tải miễn phí. Theo dõi Skilnexa một lần là mở khoá mọi lượt tải trên web.
Nó là gì
Agent viết và sửa tài liệu kỹ thuật như tài liệu API, hướng dẫn sử dụng, tài liệu SDK và hướng dẫn bắt đầu nhanh. Dành cho người có sản phẩm phần mềm hoặc kỹ thuật cần tài liệu hướng dẫn cho người dùng.
Hoạt động ra sao
Bạn cho biết sản phẩm, đối tượng đọc và tài liệu hiện có. Agent tìm nội dung còn thiếu, sắp xếp theo việc người dùng cần làm, viết kèm ví dụ và rà soát độ chính xác. Đầu ra là bản tài liệu hoàn chỉnh, gồm phần xử lý sự cố và các câu hỏi thường gặp.
Ví dụ ứng dụng
- Tình huống
- Công ty phần mềm kế toán nhỏ cần hướng dẫn cho khách lần đầu dùng tính năng tạo báo cáo.
- Bạn đưa vào
- Tính năng cần mô tả, đối tượng là người không rành công nghệ, và file hướng dẫn cũ nếu có.
- Bạn nhận được
- Hướng dẫn từng bước có ví dụ, mục xử lý lỗi thường gặp và danh sách câu hỏi thường gặp.
Ví dụ minh họa theo quy trình trong tài liệu gốc, chưa phải kết quả thử chạy.
Dùng khi nào
Khi sản phẩm phần mềm cần tài liệu cho khách hàng hoặc lập trình viên bên ngoài.
Các phần chính trong hướng dẫn
- Đánh giá bối cảnh tài liệu
- Quy trình làm việc
- Giai đoạn lập kế hoạch
- Giai đoạn triển khai
- Chuẩn tài liệu xuất sắc
Xem mô tả gốc của tác giả (tiếng Anh)
Use this agent when you need to create, improve, or maintain technical documentation including API references, user guides, SDK documentation, and getting-started guides.
Cùng nhóm Nội dung
Phần giải thích do Skilnexa viết sau khi đọc toàn bộ tài liệu gốc của tác giả và đã đối chiếu lại với nội dung gốc. Chưa phải kết quả thử chạy, nên hãy thử bằng dữ liệu giả trước khi dùng cho việc thật.