Tạo tài liệu dự án bằng GitHub Copilot
Tài liệu dự án mô tả mục đích, mục tiêu và yêu cầu của một dự án. Để tạo tài liệu dự án, bạn cần hiểu cấu trúc dự án, các thành phần của dự án và cách các thành phần tương tác với nhau.
Chế độ xem Trò chuyện của GitHub Copilot là một công cụ lý tưởng để tạo tài liệu dự án, vì nó có thể phân tích toàn bộ cấu trúc dự án và cung cấp tổng quan cấp cao về dự án. Chế độ xem Trò chuyện cũng có thể được sử dụng để tạo các loại tài liệu cụ thể, chẳng hạn như tệp README, tham chiếu API và các tài liệu liên quan đến dự án khác.
Bạn có thể sử dụng từng chế độ xem Trò chuyện (Hỏi, Tổng đài viên hoặc Kế hoạch) để tạo tài liệu dự án. Mỗi chế độ đều có những điểm mạnh và nhược điểm riêng. Đặc tả dự án và các ràng buộc khác ảnh hưởng đến chế độ nên được sử dụng.
Quan trọng
Khi bạn sử dụng chế độ xem Trò chuyện ở chế độ tổng đài viên, mỗi lời nhắc bạn nhập được tính là một yêu cầu cao cấp, nhân với hệ số nhân của mô hình. GitHub Copilot có thể thực hiện một số hành động tiếp theo để hoàn thành nhiệm vụ của mình, nhưng những hành động tiếp theo này không được tính vào mức sử dụng yêu cầu trả phí của bạn. Chỉ những lời nhắc bạn nhập mới được lập hóa đơn. Tổng số yêu cầu cao cấp được sử dụng phụ thuộc vào số lượng lời nhắc bạn nhập và mô hình đã chọn.
Thiết lập các yêu cầu về tài liệu dự án
Loại tài liệu và yêu cầu về nội dung phụ thuộc vào dự án, người tiêu dùng dự kiến và các tiêu chuẩn mà tổ chức thông qua.
Ví dụ: danh sách README.md thể bao gồm các phần sau:
- Tiêu đề Dự án: Tên dự án của bạn.
- Mô tả: Tổng quan ngắn gọn về những gì dự án làm và lý do tại sao nó tồn tại.
- Mục lục: Tùy chọn, nhưng hữu ích cho readMEs dài hơn.
- Cài đặt: Hướng dẫn cách cài đặt và thiết lập dự án.
- Sử dụng: Ví dụ về cách sử dụng dự án, bao gồm đoạn mã hoặc ảnh chụp màn hình.
- Tính năng: Danh sách các tính năng hoặc chức năng chính.
- Cấu hình: Chi tiết về bất kỳ tùy chọn cấu hình hoặc biến môi trường.
- Đóng góp: Hướng dẫn đóng góp cho dự án.
- Giấy phép: Bất kỳ giấy phép nào được sử dụng bởi dự án phân phối.
- Tín dụng và ghi nhận: Nhận dạng người đóng góp, thư viện hoặc tài nguyên được sử dụng.
- Liên hệ: Cách liên hệ với người duy trì hoặc nhóm dự án.
- Changelog: Lịch sử các thay đổi và cập nhật (đôi khi được liên kết với một tệp riêng biệt).
GitHub Copilot Chat có thể giúp bạn tạo tài liệu dự án đáp ứng nhu cầu cụ thể của dự án và các bên liên quan.
Sử dụng chế độ Hỏi tổng đài viên để tạo tài liệu dự án
Chế độ Hỏi tổng đài viên có thể được sử dụng để phân tích không gian làm việc và sau đó tạo tài liệu.
Sử dụng quy trình sau để tạo tài liệu dự án bằng chế độ Hỏi tổng đài viên:
Xác định các yêu cầu tài liệu và tài nguyên hỗ trợ.
Xác định các yêu cầu về tài liệu cho dự án của bạn. Xác định loại tài liệu và các phần tài liệu bắt buộc.
Xác định các tài nguyên cần thiết để tạo tài liệu. Không gian làm việc mã của bạn có thể là tài nguyên yêu cầu duy nhất. Tuy nhiên, bạn có thể cần thêm ngữ cảnh vào cuộc trò chuyện cho các phần như "Đóng góp", "Tín dụng" và "Liên hệ".
Mở chế độ xem Trò chuyện và bắt đầu phiên trò chuyện mới bằng chế độ Hỏi tổng đài viên.
Thêm ngữ cảnh vào phiên trò chuyện.
- Bạn có thể thêm ngữ cảnh vào phiên trò chuyện bằng cách kéo và thả tệp từ chế độ xem EXPLORER của Visual Studio Code vào chế độ xem Trò chuyện. Bạn cũng có thể sử dụng nút Đính kèm ngữ cảnh (biểu tượng kẹp giấy).
- Bạn có thể mở các tệp bên ngoài trong trình soạn thảo mã để bao gồm các tài nguyên không phải là một phần của không gian làm việc và sử dụng chúng để cung cấp thêm ngữ cảnh. Ví dụ: bạn có thể mở các tệp đánh dấu có chứa hướng dẫn của người đóng góp hoặc thông tin liên hệ, sau đó sử dụng nút Đính kèm ngữ cảnh để thêm chúng vào ngữ cảnh chế độ xem Trò chuyện.
Nhập một chuỗi lời nhắc điều tra các yêu cầu về tài liệu của bạn.
Bạn có thể sử dụng chế độ Hỏi tổng đài viên để phân tích không gian làm việc và xây dựng lịch sử phiên trò chuyện hỗ trợ các yêu cầu tài liệu của bạn. Mô tả mục tiêu của bạn có thể giúp thiết lập ngữ cảnh cho phiên trò chuyện. Đặt câu hỏi giải quyết các yêu cầu của bạn giúp GitHub Copilot xác định thông tin cần thiết để tạo tài liệu.
Làm mới ngữ cảnh được thêm vào nếu cần.
Nhập lời nhắc yêu cầu tài liệu dự án được đề xuất, liệt kê các phần bắt buộc mà bạn đã xác định ở bước đầu tiên.
Ví dụ: "
@workspace /explain I need help creating a README file that can be used in the GitHub repository for this workspace. The file should be formatted as markdown. The README file needs to include the following sections: Project Title, Description, Table of Contents, Installation, Usage, Features, Configuration, and License."Xem lại tài liệu dự án được đề xuất và tinh chỉnh kết quả bằng lời nhắc mới nếu cần.
Di chuyển tài liệu dự án được đề xuất vào tệp tài liệu dự án.
Ví dụ: tạo README.md tệp mới tại gốc của không gian làm việc và chèn nội dung được đề xuất vào tệp.
Bạn có thể sử dụng chế độ Hỏi tổng đài viên để đề xuất cập nhật cho các phần cụ thể của dự án sau khi tạo tài liệu hoặc sử dụng các công cụ GitHub Copilot khác để trợ giúp cập nhật.
Sử dụng chế độ Kế hoạch để tạo tài liệu dự án
Chế độ kế hoạch là tốt nhất để tạo kế hoạch thực hiện chi tiết trước khi tạo tài liệu dự án. Chế độ Kế hoạch phân tích cơ sở mã, xác định các yêu cầu tài liệu và tạo kế hoạch từng bước. Sau khi kế hoạch được phê duyệt, bạn có thể chuyển nó sang chế độ đại lý để thực hiện.
Sử dụng quy trình sau để tạo tài liệu dự án, chẳng hạn như tệp README.md, sử dụng chế độ Kế hoạch:
Xác định các yêu cầu tài liệu và tài nguyên hỗ trợ.
Mở chế độ xem Trò chuyện và bắt đầu phiên trò chuyện mới bằng chế độ Kế hoạch.
Nhập lời nhắc mô tả nhiệm vụ tài liệu của bạn.
Ví dụ: "Tôi cần tạo một tệp README và tài liệu hỗ trợ cho dự án này. README phải bao gồm: Tiêu đề dự án, Mô tả, Mục lục, Cài đặt, Cách sử dụng, Tính năng, Cấu hình và Giấy phép."
Xem xét kế hoạch thực hiện.
Sau một lúc, tổng đài viên Kế hoạch xuất kế hoạch trong chế độ xem Trò chuyện. Kế hoạch cung cấp một bản tóm tắt cấp cao và phân tích các bước, bao gồm bất kỳ câu hỏi mở nào để làm rõ. Bạn có thể lặp lại nhiều lần để làm rõ yêu cầu, điều chỉnh phạm vi hoặc trả lời câu hỏi.
Sau khi kế hoạch hoàn tất, hãy chọn Bắt đầu triển khai để chuyển kế hoạch sang chế độ tổng đài viên hoặc chọn Mở trong Trình chỉnh sửa để lưu kế hoạch dưới dạng tệp Markdown để sử dụng sau này.
Khi bạn chọn Bắt đầu triển khai, GitHub Copilot chuyển sang chế độ tổng đài viên và bắt đầu triển khai tài liệu dựa trên kế hoạch đã được phê duyệt. Xem lại các tệp tài liệu đã tạo và chấp nhận hoặc loại bỏ các thay đổi.
Sử dụng chế độ tác nhân để tạo tài liệu dự án
Chế độ trợ lý là tốt nhất để tạo tài liệu dự án đòi hỏi sự hiểu biết sâu sắc về dự án. Chế độ đại diện phân tích toàn bộ cấu trúc dự án trước khi tạo tài liệu dự án. Bằng cách thu thập thông tin từ nhiều tệp và thư mục, chế độ tác nhân có thể mô tả các mối quan hệ phức tạp và bao gồm nối kết giữa các tài liệu.
Sử dụng quy trình sau để tạo tài liệu dự án, chẳng hạn như tệp README.md, sử dụng chế độ tác nhân:
Xác định các yêu cầu tài liệu và tài nguyên hỗ trợ.
Mở dạng xem Trò chuyện và bắt đầu một phiên trò chuyện mới bằng cách sử dụng chế độ trợ lý.
Thêm ngữ cảnh vào phiên trò chuyện.
Người dự trò chuyện không sẵn dùng trong chế độ đại diện, vì vậy bạn không thể chỉ định như
@workspacemột phần trong lời nhắc của mình. Tuy nhiên, bạn có thể thêm ngữ cảnh vào phiên trò chuyện bằng cách sử#codebasedụng và bằng cách thêm tệp và thư mục không gian làm việc vào ngữ cảnh trò chuyện. Các tệp bên ngoài có thể được mở trong Visual Studio Code và sau đó thêm vào ngữ cảnh trò chuyện bằng cách sử dụng nút Đính kèm ngữ cảnh.Nhập lời nhắc để tạo tài liệu dự án dự kiến.
Ví dụ: "Tạo tuyển tập các tệp tài liệu dự án. Tạo hoặc cập nhật tệp README.md việc cho kho này. Tạo hoặc cập nhật tệp UsageExamples.md của bạn. Tạo hoặc cập nhật tệp ChangeLog.md của bạn. Bao gồm các liên kết giữa các tệp tài liệu, các lớp và phương pháp tham chiếu chéo, và đảm bảo tính nhất quán trong các tài liệu."
Xem lại các tệp tài liệu và sau đó lưu hoặc bỏ các bản cập nhật.
Cập nhật tệp bằng cách sử dụng lời nhắc để sửa hoặc nâng cao các mục cụ thể nếu cần.
Chức năng của chế độ trợ lý
Có một số tác vụ tài liệu trong đó chế độ tác nhân là lựa chọn tốt nhất.
Tạo tài liệu nhiều tệp và chéo tệp.
- Chế độ tác nhân có thể phân tích toàn bộ cấu trúc dự án, thu thập thông tin từ nhiều tệp và thư mục, đồng thời tạo tài liệu liên kết và tóm tắt nội dung trên cơ sở mã. Ví dụ: tạo tham chiếu API đầy đủ hoặc README mô tả tất cả các thành phần chính.
Phân tích và tóm tắt dự án tự động.
- Chế độ trợ lý có thể thực hiện các tác vụ như tóm tắt kiến trúc, xác định các lớp/dịch vụ chính và tạo sơ đồ hoặc bảng yêu cầu hiểu mối quan hệ giữa các tệp và cấu phần.
Tạo nội dung động (ví dụ: ví dụ về mức sử dụng, bảng lớp)
- Chế độ tác nhân có thể quét dự án để tạo ví dụ sử dụng, bảng trách nhiệm lớp hoặc danh sách API công cộng.
Tác vụ hàng loạt tài liệu.
- Chế độ trợ lý có thể thực thi một chuỗi tác vụ tài liệu (ví dụ: cập nhật README, tạo CONTRIBUTING.md, tạo tài liệu API, cập nhật ký) trong một dòng công việc.
Liên kết và điều hướng thông minh.
- Chế độ trợ lý có thể tạo liên kết giữa các tệp tài liệu, lớp và phương pháp tham chiếu chéo cũng như đảm bảo tính nhất quán giữa các tài liệu.
Chế độ trợ lý lý tưởng cho các tác vụ tài liệu trên toàn dự án, nhiều tệp và theo ngữ cảnh yêu cầu phân tích, tổng hợp và phối hợp.
Tóm tắt
GitHub Copilot có thể giúp bạn tạo tài liệu dự án đáp ứng nhu cầu cụ thể của dự án và các bên liên quan. Chế độ xem Trò chuyện có thể được sử dụng để tạo tài liệu dự án ở ba chế độ khác nhau: Hỏi, Tổng đài viên và Kế hoạch. Mỗi chế độ có những điểm mạnh và nhược điểm riêng, và chế độ tốt nhất để sử dụng phụ thuộc vào nhiệm vụ cụ thể trong tay. Chế độ Hỏi nhân viên là tốt nhất để đặt câu hỏi về cơ sở mã hoặc khái niệm công nghệ của bạn. Chế độ Agent là tốt nhất để tạo tài liệu dự án đòi hỏi sự hiểu biết sâu sắc về dự án. Chế độ Kế hoạch là tốt nhất để tạo kế hoạch triển khai chi tiết trước khi tạo tài liệu, sau đó có thể chuyển sang chế độ Tác nhân để thực hiện.