GitHub Copilot kullanarak proje belgeleri oluşturma
Proje belgeleri bir projenin amacını, hedeflerini ve gereksinimlerini açıklar. Proje belgeleri oluşturmak için proje yapısını, bileşenlerini ve bileşenlerin birbirleriyle nasıl etkileşim kuracağını anlamanız gerekir.
GitHub Copilot'nin Sohbet görünümü, proje yapısının tamamını analiz edip projenin üst düzey genel bakışını sağlayabildiği için proje belgeleri oluşturmak için ideal bir araçtır. Sohbet görünümü, BENİOKU dosyaları, API başvuruları ve projeyle ilgili diğer belgeler gibi belirli belge türlerini oluşturmak için de kullanılabilir.
Proje belgeleri oluşturmak için Sohbet görünümü modlarının (Ask, Agent veya Plan) her birini kullanabilirsiniz. Her modun kendi güçlü ve zayıf yönleri vardır. Proje belirtimleri ve diğer kısıtlamalar hangi modun kullanılması gerektiğini etkiler.
Önemli
Aracı modunda Sohbet görünümünü kullandığınızda, girdiğiniz her istem, modelin çarpanı ile çarpılarak tek bir premium istek olarak sayılır. GitHub Copilot görevinizi tamamlamak için birkaç izleme eylemi gerçekleştirebilir, ancak bu izleme eylemleri premium istek kullanımınıza uygun değildir. Yalnızca girdiğiniz istemler faturalandırılır. Kullanılan toplam premium istek sayısı, kaç istem girdiğinize ve modelin seçili olduğuna bağlıdır.
Proje belgeleri gereksinimlerini oluşturma
Belge türleri ve içerik gereksinimleri projeye, hedeflenen tüketicilere ve kuruluş tarafından benimsenen standartlara bağlıdır.
Örneğin, README.md aşağıdaki bölümleri içerebilir:
- Proje Başlığı: Projenizin adı.
- Açıklama: Projenin ne yaptığı ve neden var olduğu hakkında kısa bir genel bakış.
- İçindekiler Tablosu: İsteğe bağlı, ancak uzun README dosyaları için yararlıdır.
- Yükleme: Projeyi yükleme ve ayarlama yönergeleri.
- Kullanım: Kod parçacıkları veya ekran görüntüleri de dahil olmak üzere projenin nasıl kullanılacağına ilişkin örnekler.
- Özellikler: Temel özelliklerin veya işlevlerin listesi.
- Yapılandırma: Tüm yapılandırma seçenekleri veya ortam değişkenleriyle ilgili ayrıntılar.
- Katkıda Bulunma: Projeye katkıda bulunma yönergeleri.
- Lisans: Dağıtılmış proje tarafından kullanılan tüm lisanslar.
- Krediler ve bildirimler: Katkıda bulunanların, kitaplıkların veya kullanılan kaynakların tanınması.
- İletişim: Bakımcılara veya proje ekibine ulaşma.
- Değişiklik günlüğü: Değişikliklerin ve güncelleştirmelerin geçmişi (bazen ayrı bir dosyaya bağlanır).
GitHub Copilot Sohbet, projenizin ve proje katılımcılarının belirli gereksinimlerini karşılayan proje belgeleri oluşturmanıza yardımcı olabilir.
Proje belgeleri oluşturmak için Aracıya sor modunu kullanma
Aracıya sor modu, çalışma alanını analiz etmek ve ardından belge oluşturmak için kullanılabilir.
Aracıya sor modunu kullanarak proje belgeleri oluşturmak için aşağıdaki işlemi kullanın:
Belge gereksinimlerini ve destekleyici kaynakları belirleme.
Projenizin belge gereksinimlerini belirleyin. Belge türlerini ve gerekli belge bölümlerini tanımlayın.
Belgeleri oluşturmak için gereken kaynakları belirleyin. Kod çalışma alanınız tek gerekli kaynak olabilir. Bununla birlikte, "Katkıda Bulunma", "Krediler" ve "Kişi" gibi bölümler için sohbete bağlam eklemeniz gerekebilir.
Sohbet görünümünü açın ve Aracıya sor modunu kullanarak yeni bir sohbet oturumu başlatın.
Sohbet oturumuna bağlam ekleyin.
- dosyaları Visual Studio Code EXPLORER görünümünden Sohbet görünümüne sürükleyip bırakarak sohbet oturumuna bağlam ekleyebilirsiniz. Bağlam Ekle (ataş simgesi) düğmesini de kullanabilirsiniz.
- Çalışma alanının parçası olmayan kaynakları eklemek için kod düzenleyicisinde dış dosyaları açabilir ve bunları kullanarak daha fazla bağlam sağlayabilirsiniz. Örneğin, katkıda bulunan yönergeleri veya kişi bilgilerini içeren markdown dosyalarını açabilir ve ardından Bağlam Ekle düğmesini kullanarak bunları Sohbet görünümü bağlamı'na ekleyebilirsiniz.
Belge gereksinimlerinizi araştıran bir dizi istem girin.
Aracıya sor modunu kullanarak çalışma alanını analiz edebilir ve belge gereksinimlerinizi destekleyen bir sohbet oturumu geçmişi oluşturabilirsiniz. Hedeflerinizi açıklamanız sohbet oturumu için bağlam oluşturmaya yardımcı olabilir. Gereksinimlerinizi karşılayan sorular sormak, GitHub Copilot belgeleri oluşturmak için gereken bilgileri belirlemenize yardımcı olur.
Eklenen bağlamı gerektiği gibi yenileyin.
İlk adımda tanımladığınız gerekli bölümleri listeleyerek önerilen proje belgelerini isteyen bir istem girin.
Örneğin: "
@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."Önerilen proje belgelerini gözden geçirin ve gerekirse yeni istemler kullanarak sonuçları geliştirin.
Önerilen proje belgelerini bir proje belge dosyasına taşıyın.
Örneğin, çalışma alanının kökünde bir README.md dosyası oluşturun ve önerilen içeriği dosyaya ekleyin.
Belgeyi oluşturduktan sonra projenizin belirli bölümleri için güncelleştirme önermek için Aracıya sor modunu kullanabilir veya güncelleştirmelerle ilgili yardım almak için diğer GitHub Copilot araçlarını kullanabilirsiniz.
Proje belgeleri oluşturmak için Plan modunu kullanma
Plan modu, proje belgeleri oluşturmadan önce ayrıntılı bir uygulama planı oluşturmak için en iyisidir. Plan modu kod tabanını analiz eder, belge gereksinimlerini tanımlar ve adım adım bir plan oluşturur. Plan onaylandıktan sonra yürütme için aracı moduna devredebilirsiniz.
Plan modunu kullanarak README.md dosyası gibi proje belgeleri oluşturmak için aşağıdaki işlemi kullanın:
Belge gereksinimlerini ve destekleyici kaynakları belirleme.
Sohbet görünümünü açın ve Plan modunu kullanarak yeni bir sohbet oturumu başlatın.
Belge görevinizi açıklayan bir istem girin.
Örneğin: "Bu proje için bir README dosyası ve destekleyici belgeler oluşturmam gerekiyor. README dosyası şunları içermelidir: Proje Başlığı, Açıklama, İçindekiler Tablosu, Kurulum, Kullanım, Özellikler, Yapılandırma ve Lisans.
Uygulama planını gözden geçirin.
Birkaç dakika sonra Plan aracısı Sohbet görünümünde bir plan oluşturur. Plan, açıklamaya yönelik açık sorular da dahil olmak üzere üst düzey bir özet ve adımların dökümünü sağlar. Gereksinimleri netleştirmek, kapsamı ayarlamak veya soruları yanıtlamak için birden çok kez yineleyebilirsiniz.
Plan tamamlandıktan sonra, planı aracı moduna vermek için Uygulamayı Başlat'ı seçin veya planı daha sonra kullanmak üzere Markdown dosyası olarak kaydetmek için Düzenleyicide Aç'ı seçin.
Başla Uygulama'yi seçtiğinizde, GitHub Copilot aracı moduna geçer ve onaylanan plana göre belgeleri uygulamaya başlar. Oluşturulan belge dosyalarını gözden geçirin ve değişiklikleri kabul edin veya atın.
Proje belgeleri oluşturmak için aracı modunu kullanma
Aracı modu, projenin ayrıntılı bir şekilde anlaşılmasını gerektiren proje belgeleri oluşturmak için en iyisidir. Aracı modu, proje belgelerini oluşturmadan önce proje yapısının tamamını analiz eder. Aracı modu, birden çok dosya ve klasörden bilgi toplayarak karmaşık ilişkileri açıklayabilir ve belgeler arasındaki bağlantıları içerebilir.
Aracı modunu kullanarak README.md dosyası gibi proje belgeleri oluşturmak için aşağıdaki işlemi kullanın:
Belge gereksinimlerini ve destekleyici kaynakları belirleme.
Sohbet görünümünü açın ve aracı modunu kullanarak yeni bir sohbet oturumu başlatın.
Sohbet oturumuna bağlam ekleyin.
Sohbet katılımcıları acente modunda kullanılamaz. Bu nedenle, isteminizin bir parçası olarak
@workspacebelirtemezsiniz. Ancak,#codebaseve çalışma alanı dosyalarını ve klasörlerini sohbet bağlamına ekleyerek sohbet oturumuna bağlam ekleyebilirsiniz. Dış dosyalar Visual Studio Code açılabilir ve ardından Attach Context düğmesi kullanılarak sohbet bağlamlarına eklenebilir.Hedeflenen proje belgelerini oluşturmak için bir istem girin.
Örneğin: "Proje belge dosyaları koleksiyonu oluşturun. Bu depo için çalışma alanı README.md dosyasını oluşturun veya güncelleştirin. UsageExamples.md dosyasını oluşturun veya güncelleştirin. ChangeLog.md dosyasını oluşturun veya güncelleştirin. Belge dosyaları, çapraz başvuru sınıfları ve yöntemleri arasında bağlantılar ekleyin ve belgeler arasında tutarlılık sağlayın."
Belge dosyalarını gözden geçirin ve ardından güncelleştirmeleri kaydedin veya atın.
Gerekirse belirli bölümleri düzeltmek veya geliştirmek için istemleri kullanarak dosyayı güncelleştirin.
Aracı modu özellikleri
Aracı modunun en iyi seçenek olduğu çeşitli belge görevleri vardır.
Çok dosyalı ve çapraz dosya belgeleri oluşturma.
- Aracı modu proje yapısının tamamını analiz edebilir, birden çok dosya ve klasördeki bilgileri toplayabilir ve kod tabanındaki içeriği bağlayan ve özetleyen belgeler oluşturabilir. Örneğin, tüm ana bileşenleri açıklayan tam bir API referansı veya README dosyası oluşturulması.
Otomatik proje analizi ve özetleme.
- Aracı modu mimariyi özetleme, ana sınıfları/hizmetleri tanımlama ve dosyalar ve bileşenler arasındaki ilişkilerin anlaşılmasını gerektiren diyagramlar veya tablolar oluşturma gibi görevleri gerçekleştirebilir.
Dinamik içerik oluşturma (örneğin, kullanım örnekleri, sınıf tabloları)
- Aracı modu, kullanım örnekleri, sınıf sorumluluk tabloları veya genel API'lerin listelerini oluşturmak için projeyi tarar.
Toplu belge görevleri.
- Ajans modu, tek bir iş akışında bir dizi belgeleme görevi (örneğin, README güncelleştirme, CONTRIBUTING.md oluşturma, API belgeleri oluşturma, değişiklik günlüğü güncelleştirme) yürütebilir.
Akıllı bağlantı ve gezinti.
- Aracı modu belge dosyaları, çapraz başvuru sınıfları ve yöntemleri arasında bağlantılar oluşturabilir ve belgeler arasında tutarlılık sağlayabilir.
Aracı modu, analiz, sentez ve koordinasyon gerektiren proje genelinde, çok dosyalı ve bağlama duyarlı belge görevleri için idealdir.
Özet
GitHub Copilot, projenizin ve proje katılımcılarının belirli gereksinimlerini karşılayan proje belgeleri oluşturmanıza yardımcı olabilir. Sohbet görünümü üç farklı modda proje belgeleri oluşturmak için kullanılabilir: Ask, Agent ve Plan. Her modun kendi güçlü ve zayıf yönleri vardır ve kullanılacak en iyi mod eldeki belirli göreve bağlıdır. Aracıya sorun modu, kod tabanınız veya teknoloji kavramlarınız hakkında sorular sormak için en iyisidir. Aracı modu, projenin ayrıntılı bir şekilde anlaşılmasını gerektiren proje belgeleri oluşturmak için en iyisidir. Plan modu, belge oluşturmadan önce ayrıntılı bir uygulama planı oluşturmak için en iyisidir. Bu plan yürütme için Aracı moduna devredilebilir.