SSkilnexa
AgentKỹ thuật phần mềmHợp với: Đội phát triển phần mềmMức: Vừa

Soạn và cập nhật tài liệu dự án

documentation-specialist

Viết README, đặc tả API, hướng dẫn kiến trúc và sách hướng dẫn người dùng; chuyển phần kỹ thuật sâu cho các agent khác viết.

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út theo dõi đang được chuẩn bị.
Link tải đang được chuẩn bị.

Nó là gì

Vai trò soạn và cập nhật tài liệu dự án như README, tài liệu API, kiến trúc và hướng dẫn sử dụng. Viết để người mới vào dự án đọc hiểu nhanh.

Hoạt động ra sao

Bạn chỉ dự án và phần còn thiếu. AI so tài liệu hiện có với mã, lập dàn ý, viết Markdown theo mẫu, rồi kiểm tra lại độ chính xác và liên kết. Đầu ra là các tệp README, docs/api.md hoặc docs/architecture.md.

Ví dụ ứng dụng

Tình huống
Dự án nội bộ của văn phòng đã chạy được nhưng chưa ai viết hướng dẫn cài đặt.
Bạn đưa vào
Thư mục dự án, README cũ và danh sách tính năng mới nhất.
Bạn nhận được
README mới có mục cài đặt, sơ đồ kiến trúc và ví dụ lệnh curl.

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 vừa xong tính năng lớn hoặc có người mới vào đội và cần tài liệu mới.

Các phần chính trong hướng dẫn

  1. Nhiệm vụ
  2. Quy trình làm việc
  3. Mẫu tài liệu
  4. Khung README
  5. Bản nháp OpenAPI
  6. Trích đoạn hướng dẫn kiến trúc
  7. Thực hành tốt nhất
  8. Yêu cầu kết quả
Xem mô tả gốc của tác giả (tiếng Anh)

MUST BE USED to craft or update project documentation. Use PROACTIVELY after major features, API changes, or when onboarding developers. Produces READMEs, API specs, architecture guides, and user manuals; delegates to other agents for deep tech details.

Ví dụ yêu cầu

  • [API](docs/api.md)
  • [Architecture](docs/architecture.md)

Cùng nhóm Kỹ thuật phần mềm

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.