Viết tài liệu kỹ thuật, README, runbook
documentation
Soạn tài liệu kỹ thuật các loại: README, tài liệu API, tài liệu kiến trúc, hướng dẫn cho người mới và sổ tay vận hành.
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ì
Viết và duy trì tài liệu kỹ thuật như README, tài liệu API, runbook (hướng dẫn xử lý vận hành) và tài liệu kiến trúc. Khác nhờ AI viết chung chung, nó soạn theo từng loại tài liệu và từng người đọc.
Hoạt động ra sao
AI soạn theo đúng loại tài liệu bạn chọn, ưu tiên thông tin người đọc cần nhất trước. Với runbook, nó gồm lúc nào dùng, quyền cần có, các bước, cách quay lui và người cần báo khi leo thang.
Ví dụ ứng dụng
- Tình huống
- Cửa hàng có hệ thống đặt hàng nội bộ, nhân viên mới chưa biết cài môi trường để chạy thử.
- Bạn đưa vào
- Ghi chú về hệ thống, các bước cài đặt đang có và ai là người cần hỏi khi gặp lỗi.
- Bạn nhận được
- Tài liệu hướng dẫn nhận việc gồm cài môi trường, các hệ thống liên quan và việc 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 dự án chưa có README và cần ghi lại cách cài đặt.
Các phần chính trong hướng dẫn
- Các loại tài liệu
- README
- Tài liệu API
- Sổ tay vận hành
- Tài liệu kiến trúc
- Hướng dẫn cho người mới
- Nguyên tắc viết
Xem mô tả gốc của tác giả (tiếng Anh)
Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.
Cùng nhóm Kỹ thuật phần mềm
- Kiểm tra và sửa lỗi truy cập cho người khuyết tậtQuét mã web theo WCAG 2.2 mức A và AA, tự sửa lỗi, kiểm độ tương phản màu, lập báo cáo; chạy được cho React, Vue, Angular, Svelte, HTML.
- Rà soát mã khắt khe qua ba góc nhìnXem lại thay đổi mã bằng ba nhân vật khó tính: kẻ phá hoại, người mới vào và kiểm toán bảo mật; mỗi người phải tìm ra lỗi, kết luận BLOCK, CONCERNS hoặc CLEAN.
- Điều quân đoàn agent làm việc lớn song songTriển khai hai lớp agent song song cho việc lớn như viết lại nhiều tệp, di chuyển hàng loạt, kiểm tra toàn mã nguồn, có an toàn git và kiểm tra trước khi chạy.
- Thiết kế hệ nhiều agent phối hợpChọn kiểu điều phối (giám sát, bầy đàn, dây chuyền), tạo khai báo công cụ cho agent và phân tích nhật ký chạy về chi phí, độ trễ, lỗi.
- Chạy bầy agent xử lý dữ liệu hàng loạtTriển khai nhiều agent phụ xử lý song song các việc dữ liệu như 1000 tài liệu, phân tích bộ dữ liệu, tạo nội dung số lượng lớn; có theo dõi tiến độ và khắc phục lỗi.
- Dựng đội agent cho quy trình kinh doanhHỏi về quy trình công việc rồi tạo cấu hình đội agent gồm vai trò, quyền dùng công cụ, cách liên lạc và quy tắc bàn giao.
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.