Belgelendirme neden önemlidir

Belgelendirme güncel ve doğru bağlam sağlar. Olmadan modeller eski ya da eksik eğitim verilerini kullanır. Belgelendirme, modellerin şunları anlamasına yardımcı olur:
  • Güncel API’ler ve parametreler
  • En iyi uygulamalar
  • Organizasyon gelenekleri
  • Alan terminolojisi
Ve çok daha fazlası. Bağlam değiştirmeden belgelendirmeyi doğrudan Cursor’da nasıl kullanacağını öğrenmek için okumaya devam et.

Model bilgi kesim tarihi

Büyük dil modelleri, “bilgi kesim tarihi” denilen belirli bir zamana kadar olan verilerle eğitilir. Bu şu anlama gelir:
  • En son kütüphane güncellemeleri yansımamış olabilir
  • Yeni çatı (framework) veya araçlar bilinmeyebilir
  • Kesim tarihinden sonra yapılan API değişiklikleri atlanır
  • En iyi uygulamalar eğitimden bu yana değişmiş olabilir
Örneğin, bir modelin bilgi kesim tarihi 2024’ün başıysa, 2024’ün sonlarında çıkan özelliklerden, popüler çatı (framework)lar için bile haberdar olmaz.

Hangi aracı kullanmalıyım?

Dokümantasyon ihtiyaçların için en iyi yaklaşımı hızlıca belirlemek için bu karar ağacını kullan:

Zihinsel model

AraçZihinsel model
@DocsResmi dokümantasyonda gezinip okumak gibi
@Webİnternette çözüm aramak gibi
MCPKendi dahili dokümantasyonuna erişmek gibi

Public documentation

Harici dokümantasyon, modellerin sınırlı ya da güncelliğini yitirmiş bilgiye sahip olabileceği, herkese açık bilgileri kapsar. Cursor, bu bilgilere erişmek için iki ana yol sunar.

@Docs’u kullanma

@Docs, Cursor’ı popüler araç ve framework’lerin resmi dokümantasyonuna bağlar. Şu konularda güncel ve yetkili bilgiye ihtiyaç duyduğunda kullan:
  • API referansları: Fonksiyon imzaları, parametreler, dönüş tipleri
  • Başlangıç rehberleri: Kurulum, yapılandırma, temel kullanım
  • En iyi uygulamalar: Kaynaktan önerilen kalıplar
  • Framework’e özel hata ayıklama: Resmi sorun giderme rehberleri
@
@Docs Next.js Catch-all rotalarla dinamik yönlendirmeyi nasıl kurarım?
Agent⌘I
Auto

@Web’i kullanma

@Web, güncel bilgiler, blog yazıları ve topluluk tartışmaları için canlı internette arama yapar. Şunlara ihtiyacın olduğunda kullan:
  • Güncel eğitimler: Topluluk kaynaklı içerikler ve örnekler
  • Karşılaştırmalar: Farklı yaklaşımları karşılaştıran yazılar
  • En son güncellemeler: Çok yeni güncellemeler veya duyurular
  • Birden fazla bakış açısı: Sorunlara farklı yaklaşımlar
@
@Web React 19 için en yeni performans optimizasyonları
Agent⌘I
Auto

İç dokümantasyon

İç dokümantasyon, AI modellerinin eğitim sırasında hiç görmediği, organizasyonuna özgü bilgileri içerir. Şunları kapsayabilir:
  • Dahili API’ler: Özel servisler ve mikroservisler
  • Şirket standartları: Kodlama kuralları, mimari desenler
  • Mülkiyet sistemler: Özel araçlar, veritabanları, iş akışları
  • Alan bilgisi: İş mantığı, uyumluluk gereksinimleri

MCP ile dahili dökümanlara erişim

Model Context Protocol (MCP), özel dökümanlarını ve sistemlerini Cursor’a getirmenin standart bir yolunu sağlar. MCP, Cursor ile dahili kaynakların arasında ince bir katman olarak çalışır. MCP neden önemli:
  • Modeller dahili uygulamalarını/alışkanlıklarını tahmin edemez
  • Özel servisler için API dökümantasyonu herkese açık değildir
  • İş mantığı ve alan bilgisi organizasyonuna özeldir
  • Uyum ve güvenlik gereksinimleri şirkete göre değişir

Yaygın MCP entegrasyonları

EntegrasyonErişimÖrnekler
ConfluenceŞirket Confluence alanlarıMimari dökümantasyon, dahili servisler için API spesifikasyonları, kod standartları ve yönergeler, süreç dökümantasyonu
Google DrivePaylaşılan belgeler ve klasörlerSpesifikasyon dokümanları, toplantı notları ve karar kayıtları, tasarım dokümanları ve gereksinimler, ekip bilgi tabanları
NotionÇalışma alanı veritabanları ve sayfalarProje dökümantasyonu, ekip vikileri, bilgi tabanları, ürün gereksinimleri, teknik spesifikasyonlar
CustomDahili sistemler ve veritabanlarıTescilli API’ler, legacy dökümantasyon sistemleri, özel bilgi tabanları, uzmanlaşmış araçlar ve iş akışları

Özel çözümler

Benzersiz ihtiyaçlar için, şunları yapabilen özel MCP sunucuları geliştirebilirsin:
  • Dahili web sitelerini veya portalları taramak
  • Tescilli veritabanlarına bağlanmak
  • Özel dökümantasyon sistemlerine erişmek
  • Dahili vikilerden veya bilgi tabanlarından veri çekmek
Özel bir MCP sunucusu geliştirirsen, Cursor’ın dökümantasyonu güncellemesi için araçlar da expose edebilirsin
Dahili dökümanları taramak için örnek özel MCP sunucusu:
import { McpServer, ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { z } from "zod";
import TurndownService from "turndown";

// Dahili dökümanları taramak için bir MCP sunucusu oluştur
const server = new McpServer({
  name: "internal-docs",
  version: "1.0.0"
});

const turndownService = new TurndownService();

// Dahili dökümantasyonu taramak için tool ekle
server.tool("get_doc",
  { url: z.string() },
  async ({ url }) => {
    try {
      const response = await fetch(url);
      const html = await response.text();
      
      // HTML’i markdown’a dönüştür
      const markdown = turndownService.turndown(html);
      
      return {
        content: [{ type: "text", text: markdown }]
      };
    } catch (error) {
      return {
        content: [{ type: "text", text: `Error scraping ${url}: ${error.message}` }]
      };
    }
  }
);

// stdin üzerinden mesaj almayı ve stdout üzerinden mesaj göndermeyi başlat
const transport = new StdioServerTransport();
await server.connect(transport);

Dokümanları güncel tutmak

Dokümantasyon hızla eskir. Cursor, gerçek koduna ve geliştirme konuşmalarına dayanarak dokümantasyonu oluşturup güncelleyerek onu güncel ve faydalı tutmana yardımcı olur.

Mevcut koddan

Cursor’ı kullanarak dokümantasyonu doğrudan kod tabanından oluştur:
@
Bu Express router için, tüm uç noktalar, parametreler ve yanıt formatları dahil olmak üzere API dokümantasyonu oluştur
Agent⌘I
Auto

Sohbet oturumlarından

Cursor’la yaptığın sohbetlerde, dokümantasyona dönüştürülebilecek değerli niyetler var.
Karmaşık bir sorun çözüldükten sonra:
@
Kimlik doğrulamayı kurma üzerine sohbetimizi ekip wikisi için adım adım bir rehbere özetle
Agent⌘I
Auto

Özet

  • Belgeleri bağlam olarak kullanmak, Cursor’ı daha isabetli ve güncel yapar
  • Resmi dokümantasyon için @Docs, topluluk bilgisi için @Web kullan
  • MCP, Cursor ile dahili sistemlerin arasındaki boşluğu kapatır
  • Bilgiyi güncel tutmak için koddan ve sohbetlerden dokümantasyon üret
  • Kapsamlı bir anlayış için harici ve dahili dokümantasyon kaynaklarını birleştir