Belgelerin neden önemli olduğu

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

Model bilgi kesim tarihi

Büyük dil modelleri, “bilgi kesim tarihi” denen belirli bir zamana kadar olan verilerle eğitilir. Bu şu anlama gelir:
  • Yakın tarihli kütüphane güncellemeleri yansımamış olabilir
  • Yeni framework’ler veya araçlar bilinmeyebilir
  • Kesim tarihinden sonraki API değişiklikleri gözden kaçmış olabilir
  • 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 yayımlanan özelliklerden, popüler framework’ler için bile, haberdar olmayacaktır.

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ümantasyona göz atıp okumaya benzer
@Webİnternette çözüm aramaya benzer
MCPKendi dahili dokümantasyonuna erişmeye benzer

Public documentation

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

@Docs’u kullanma

@Docs, Cursor’ı popüler araç ve framework’lerin resmi dokümantasyonuna bağlar. Aşağıdaki konularda güncel ve güvenilir bilgiye ihtiyacın olduğunda kullan:
  • API başvuruları: Fonksiyon imzaları, parametreler, dönüş türleri
  • Hızlı başlangıç rehberleri: Kurulum, yapılandırma, temel kullanım
  • En iyi uygulamalar: Kaynağın önerdiği desenler
  • Framework’e özgü hata ayıklama: Resmi sorun giderme rehberleri
@
@Docs Next.js How do I set up dynamic routing with catch-all routes?
Agent⌘I
Auto

@Web’i kullanma

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

Dahili dokümantasyon

Dahili dokümantasyon, yapay zekâ modellerinin eğitim sırasında hiç karşılaşmadığı, organizasyonuna özgü bilgileri içerir. Şunları kapsayabilir:
  • Dahili API’ler: Özel hizmetler ve mikro hizmetler
  • Şirket standartları: Kodlama kuralları, mimari kalıplar
  • Tescilli sistemler: Özel araçlar, veritabanları, iş akışları
  • Alan bilgisi: İş mantığı, mevzuata uyum gereksinimleri

MCP ile dahili belgelere erişme

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

Yaygın MCP entegrasyonları

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

Özel çözümler

Benzersiz ihtiyaçlar için şu yeteneklere sahip özel MCP sunucuları oluşturabilirsin:
  • Dahili web sitelerini veya portalları taramak
  • Tescilli veritabanlarına bağlanmak
  • Özel dokümantasyon sistemlerine erişmek
  • Dahili vikilerden veya bilgi tabanlarından veri çekmek
Özel bir MCP sunucusu oluşturursan, Cursor’ın dokümantasyonu güncellemesi için araçları da expose edebilirsin
Dahili belgeleri 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";

// Create an MCP server for scraping internal docs
const server = new McpServer({
  name: "internal-docs",
  version: "1.0.0"
});

const turndownService = new TurndownService();

// Add tool to scrape internal documentation
server.tool("get_doc",
  { url: z.string() },
  async ({ url }) => {
    try {
      const response = await fetch(url);
      const html = await response.text();
      
      // Convert HTML to markdown
      const markdown = turndownService.turndown(html);
      
      return {
        content: [{ type: "text", text: markdown }]
      };
    } catch (error) {
      return {
        content: [{ type: "text", text: `Error scraping ${url}: ${error.message}` }]
      };
    }
  }
);

// Start receiving messages on stdin and sending messages on stdout
const transport = new StdioServerTransport();
await server.connect(transport);

Dokümanları güncel tutma

Dokümantasyon çabucak eskir. Cursor, gerçek koduna ve geliştirme konuşmalarına dayanarak dokümantasyonu oluşturup güncelleyerek dokümanlarının güncel ve kullanışlı kalmasına yardımcı olabilir.

Mevcut koddan

Cursor’ı kullanarak belgeleri doğrudan kod tabanından oluştur:
@
Bu Express router için tüm endpoint’ler, parametreler ve yanıt biçimleri dahil API dokümantasyonu oluştur
Agent⌘I
Auto

Sohbet oturumlarından

Cursor’la yaptığın konuşmalar, dokümantasyona dönüştürülebilecek değerli amaçlar içerir.
Karmaşık bir problemi çözdükten sonra:
@
Kimlik doğrulamayı kurma hakkındaki sohbetimizi, ekip wikisi için adım adım bir rehber olarak özetle
Agent⌘I
Auto

Çıkarımlar

  • Dokümantasyonu bağlam olarak kullanmak, Cursor’ı daha isabetli ve güncel hâle getirir
  • Resmi dokümantasyon için @Docs, topluluk bilgisi için @Web kullan
  • MCP, Cursor ile dahili sistemlerin arasında köprü kurar
  • Bilgiyi güncel tutmak için koddan ve konuşmalardan dokümantasyon üret
  • Kapsamlı bir anlayış için haricî ve dahilî dokümantasyon kaynaklarını birleştir