Dokümantasyon neden önemlidir

Dokümantasyon güncel ve doğru bağlam sağlar. Dokümantasyon olmadan, modeller güncel olmayan veya eksik eğitim verilerini kullanır. Dokümantasyon, modellerin şu gibi şeyleri anlamasına yardımcı olur:
  • Güncel API’ler ve parametreler
  • En iyi uygulamalar
  • Organizasyon konvansiyonları
  • Alan terminolojisi
Ve çok daha fazlası. Cursor’da bağlam değiştirmek zorunda kalmadan dokümantasyonu nasıl doğru kullanacağınızı öğrenmek için okumaya devam edin.

Model bilgi kesim noktası

Büyük dil modelleri, “bilgi kesim noktası” adı verilen belirli bir zamana kadar olan veriler üzerinde eğitilir. Bu şu anlama gelir:
  • Son kütüphane güncellemeleri yansıtılmayabilir
  • Yeni framework’ler veya araçlar bilinmeyebilir
  • Kesim tarihinden sonraki API değişiklikleri kaçırılır
  • En iyi uygulamalar eğitimden bu yana gelişmiş olabilir
Örneğin, bir modelin bilgi kesim noktası 2024’ün başıysa, popüler framework’ler için bile 2024’ün sonunda yayınlanan özellikler hakkında bilgi sahibi olmayacaktır.

Hangi aracı kullanmalıyım?

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

Zihinsel model

AraçZihinsel Model
@DocsResmi belgeleri taramak ve okumak gibi
@Webİnternette çözüm aramak gibi
MCPDahili belgelerinize erişmek gibi

Genel dokümantasyon

Harici dokümantasyon, modellerin sınırlı veya güncel olmayan bilgiye sahip olabileceği herkese açık bilgileri kapsar. Cursor bu bilgilere erişim için iki temel yol sunar.

@Docs Kullanımı

@Docs, Cursor’ı popüler araçlar ve framework’lerin resmi dokümantasyonlarına bağlar. Aşağıdaki durumlarda güncel ve yetkili bilgilere ihtiyaç duyduğunuzda kullanın:
  • API referansları: Fonksiyon imzaları, parametreler, dönüş türleri
  • Başlangıç kılavuzları: Kurulum, yapılandırma, temel kullanım
  • En iyi uygulamalar: Kaynaktan önerilen desenler
  • Framework’e özgü hata ayıklama: Resmi sorun giderme kılavuzları
@
@Docs Next.js Catch-all route'lar ile dinamik yönlendirmeyi nasıl kurarım?
Agent⌘I
Auto

@Web Kullanımı

@Web güncel bilgiler, blog yazıları ve topluluk tartışmaları için canlı internette arama yapar. Şu durumlarda kullanın:
  • Güncel eğitimler: Topluluk tarafından oluşturulan içerik ve örnekler
  • Karşılaştırmalar: Farklı yaklaşımları karşılaştıran makaleler
  • Son güncellemeler: Çok güncel güncellemeler veya duyurular
  • Çoklu perspektifler: Problemlere farklı yaklaşımlar
@
@Web React 19 için en son performans optimizasyonları
Agent⌘I
Auto

İç dokümantasyon

İç dokümantasyon, AI modellerinin eğitim sırasında hiç karşılaşmadığı, organizasyonunuza özel bilgileri içerir. Bunlar şunlar olabilir:
  • İç API’ler: Özel servisler ve mikroservisler
  • Şirket standartları: Kodlama konvansiyonları, mimari desenler
  • Tescilli sistemler: Özel araçlar, veritabanları, iş akışları
  • Alan bilgisi: İş mantığı, uyumluluk gereksinimleri

MCP ile dahili dokümanlara erişim

Model Context Protocol (MCP), özel dokümantasyonunuzu ve sistemlerinizi Cursor’a getirmek için standartlaştırılmış bir yol sağlar. MCP, Cursor ile dahili kaynaklarınız arasında ince bir katman görevi görür. MCP neden önemlidir:
  • Modeller dahili konvansiyonlarınızı tahmin edemez
  • Özel servisler için API dokümantasyonu herkese açık değildir
  • İş mantığı ve alan bilgisi organizasyonunuza özgüdür
  • Uyumluluk ve güvenlik gereksinimleri şirkete göre değişir

Yaygın MCP entegrasyonları

EntegrasyonErişimÖrnekler
ConfluenceŞirket Confluence alanlarıMimari dokümantasyonu, dahili servisler için API spesifikasyonları, kodlama standartları ve kılavuzları, süreç dokümantasyonu
Google DrivePaylaşılan dokümanlar ve klasörlerSpesifikasyon dokümanları, toplantı notları ve karar kayıtları, tasarım dokümanları ve gereksinimler, takım bilgi tabanları
NotionÇalışma alanı veritabanları ve sayfalarıProje dokümantasyonu, takım wikileri, bilgi tabanları, ürün gereksinimleri, teknik spesifikasyonlar
ÖzelDahili sistemler ve veritabanlarıTescilli API’ler, eski dokümantasyon sistemleri, özel bilgi tabanları, özelleştirilmiş araçlar ve iş akışları

Özel çözümler

Benzersiz ihtiyaçlar için, şunları yapan özel MCP sunucuları oluşturabilirsiniz:
  • Dahili web sitelerini veya portalları kazıma
  • Tescilli veritabanlarına bağlanma
  • Özel dokümantasyon sistemlerine erişim
  • Dahili wikilerden veya bilgi tabanlarından çekme
Özel bir MCP sunucusu oluşturursanız, Cursor’ın dokümantasyonu güncellemesi için araçlar da sunabilirsiniz
Dahili dokümanları kazımak 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 dokümanları kazımak için bir MCP sunucusu oluştur
const server = new McpServer({
  name: "internal-docs",
  version: "1.0.0"
});

const turndownService = new TurndownService();

// Dahili dokümantasyonu kazımak için araç ekle
server.tool("get_doc",
  { url: z.string() },
  async ({ url }) => {
    try {
      const response = await fetch(url);
      const html = await response.text();
      
      // HTML'yi markdown'a dönüştür
      const markdown = turndownService.turndown(html);
      
      return {
        content: [{ type: "text", text: markdown }]
      };
    } catch (error) {
      return {
        content: [{ type: "text", text: `${url} kazıma hatası: ${error.message}` }]
      };
    }
  }
);

// stdin'den mesaj almaya ve stdout'a mesaj göndermeye başla
const transport = new StdioServerTransport();
await server.connect(transport);

Dokümantasyonu güncel tutma

Dokümantasyon hızla eskir. Cursor, gerçek kodunuz ve geliştirme konuşmalarınız temelinde dokümantasyon oluşturarak ve güncelleyerek güncel, kullanışlı dokümantasyon korumanıza yardımcı olabilir.

Mevcut koddan

Kod tabanınızdan doğrudan dokümantasyon oluşturmak için Cursor’ı kullanın:
@
Bu Express router için tüm endpoint'ler, parametreler ve yanıt formatları dahil olmak üzere API dokümantasyonu oluştur
Agent⌘I
Auto

Sohbet oturumlarından

Cursor ile yaptığınız konuşmalar, dokümantasyona dönüştürülebilecek değerli amaçlar içerir.
Karmaşık bir problemi çözdükten sonra:
@
Kimlik doğrulama kurulumu hakkındaki konuşmamızı takım wiki'si için adım adım bir rehbere özetle
Agent⌘I
Auto

Çıkarımlar

  • Bağlam olarak kullanılan dokümantasyon Cursor’ı daha doğru ve güncel hale getirir
  • Resmi dokümantasyon için @Docs, topluluk bilgisi için @Web kullanın
  • MCP, Cursor ile dahili sistemleriniz arasındaki boşluğu doldurur
  • Bilgiyi güncel tutmak için kod ve konuşmalardan dokümantasyon oluşturun
  • Kapsamlı anlayış için harici ve dahili dokümantasyon kaynaklarını birleştirin