Mengapa dokumentasi penting

Dokumentasi menyediakan konteks yang terkini dan akurat. Tanpa dokumentasi, model menggunakan data pelatihan yang sudah usang atau tidak lengkap. Dokumentasi membantu model memahami hal-hal seperti:
  • API dan parameter terkini
  • Praktik terbaik
  • Konvensi organisasi
  • Terminologi domain
Dan masih banyak lagi. Baca terus untuk mempelajari cara menggunakan dokumentasi langsung di Cursor tanpa harus beralih konteks.

Batas pengetahuan model

Model bahasa besar dilatih pada data hingga titik waktu tertentu, yang disebut “batas pengetahuan.” Ini berarti:
  • Pembaruan library terbaru mungkin tidak tercermin
  • Framework atau tools baru mungkin tidak diketahui
  • Perubahan API setelah tanggal batas terlewatkan
  • Praktik terbaik mungkin telah berkembang sejak pelatihan
Sebagai contoh, jika batas pengetahuan model adalah awal 2024, model tersebut tidak akan mengetahui tentang fitur yang dirilis pada akhir 2024, bahkan untuk framework populer.

Tool mana yang harus saya gunakan?

Gunakan pohon keputusan ini untuk dengan cepat menentukan pendekatan terbaik untuk kebutuhan dokumentasi Anda:

Model mental

ToolModel Mental
@DocsSeperti menjelajahi dan membaca dokumentasi resmi
@WebSeperti mencari solusi di internet
MCPSeperti mengakses dokumentasi internal Anda

Dokumentasi publik

Dokumentasi eksternal mencakup informasi yang tersedia secara publik yang mungkin memiliki pengetahuan terbatas atau usang pada model. Cursor menyediakan dua cara utama untuk mengakses informasi ini.

Menggunakan @Docs

@Docs menghubungkan Cursor ke dokumentasi resmi dari alat dan framework populer. Gunakan ketika Anda membutuhkan informasi terkini dan otoritatif tentang:
  • Referensi API: Signature fungsi, parameter, tipe return
  • Panduan memulai: Setup, konfigurasi, penggunaan dasar
  • Praktik terbaik: Pola yang direkomendasikan dari sumber
  • Debugging khusus framework: Panduan troubleshooting resmi
@
@Docs Next.js Bagaimana cara mengatur dynamic routing dengan catch-all routes?
Agent⌘I
Auto

Menggunakan @Web

@Web mencari internet secara langsung untuk informasi terkini, posting blog, dan diskusi komunitas. Gunakan ketika Anda membutuhkan:
  • Tutorial terbaru: Konten dan contoh yang dibuat komunitas
  • Perbandingan: Artikel yang membandingkan pendekatan berbeda
  • Pembaruan terbaru: Pembaruan atau pengumuman yang sangat baru
  • Berbagai perspektif: Pendekatan berbeda untuk masalah
@
@Web optimisasi performa terbaru untuk React 19
Agent⌘I
Auto

Dokumentasi internal

Dokumentasi internal mencakup informasi spesifik untuk organisasi Anda yang tidak pernah ditemui oleh model AI selama pelatihan. Ini mungkin berupa:
  • API internal: Layanan khusus dan microservice
  • Standar perusahaan: Konvensi coding, pola arsitektur
  • Sistem proprietary: Tool khusus, database, workflow
  • Pengetahuan domain: Logika bisnis, persyaratan kepatuhan

Mengakses dokumentasi internal dengan MCP

Model Context Protocol (MCP) menyediakan cara standar untuk membawa dokumentasi dan sistem pribadi Anda ke dalam Cursor. MCP bertindak sebagai lapisan tipis antara Cursor dan sumber daya internal Anda. Mengapa MCP penting:
  • Model tidak dapat menebak konvensi internal Anda
  • Dokumentasi API untuk layanan kustom tidak tersedia secara publik
  • Logika bisnis dan pengetahuan domain unik untuk organisasi Anda
  • Persyaratan kepatuhan dan keamanan bervariasi menurut perusahaan

Integrasi MCP umum

IntegrasiAksesContoh
ConfluenceRuang Confluence perusahaanDokumentasi arsitektur, spesifikasi API untuk layanan internal, standar dan pedoman coding, dokumentasi proses
Google DriveDokumen dan folder bersamaDokumen spesifikasi, catatan rapat dan catatan keputusan, dokumen desain dan persyaratan, basis pengetahuan tim
NotionDatabase dan halaman workspaceDokumentasi proyek, wiki tim, basis pengetahuan, persyaratan produk, spesifikasi teknis
KustomSistem dan database internalAPI proprietary, sistem dokumentasi legacy, basis pengetahuan kustom, alat dan alur kerja khusus

Solusi kustom

Untuk kebutuhan unik, Anda dapat membangun server MCP kustom yang:
  • Mengambil data dari situs web atau portal internal
  • Terhubung ke database proprietary
  • Mengakses sistem dokumentasi kustom
  • Mengambil dari wiki internal atau basis pengetahuan
Jika Anda membangun server MCP kustom, Anda juga dapat mengekspos alat untuk Cursor memperbarui dokumentasi
Contoh server MCP kustom untuk mengambil data dokumentasi internal:
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";

// Buat server MCP untuk mengambil data dokumentasi internal
const server = new McpServer({
  name: "internal-docs",
  version: "1.0.0"
});

const turndownService = new TurndownService();

// Tambahkan alat untuk mengambil data dokumentasi internal
server.tool("get_doc",
  { url: z.string() },
  async ({ url }) => {
    try {
      const response = await fetch(url);
      const html = await response.text();
      
      // Konversi HTML ke markdown
      const markdown = turndownService.turndown(html);
      
      return {
        content: [{ type: "text", text: markdown }]
      };
    } catch (error) {
      return {
        content: [{ type: "text", text: `Error scraping ${url}: ${error.message}` }]
      };
    }
  }
);

// Mulai menerima pesan di stdin dan mengirim pesan di stdout
const transport = new StdioServerTransport();
await server.connect(transport);

Menjaga dokumentasi tetap terkini

Dokumentasi menjadi usang dengan cepat. Cursor dapat membantu Anda memelihara dokumentasi yang terkini dan berguna dengan menghasilkan dan memperbaruinya berdasarkan kode aktual dan percakapan pengembangan Anda.

Dari kode yang sudah ada

Gunakan Cursor untuk membuat dokumentasi langsung dari codebase Anda:
@
Buat dokumentasi API untuk Express router ini, termasuk semua endpoint, parameter, dan format respons
Agent⌘I
Auto

Dari sesi chat

Percakapan Anda dengan Cursor mengandung maksud berharga yang dapat diubah menjadi dokumentasi.
Setelah menyelesaikan masalah kompleks:
@
Rangkum percakapan kita tentang pengaturan autentikasi menjadi panduan langkah demi langkah untuk wiki tim
Agent⌘I
Auto

Poin Penting

  • Dokumentasi sebagai konteks membuat Cursor lebih akurat dan terkini
  • Gunakan @Docs untuk dokumentasi resmi dan @Web untuk pengetahuan komunitas
  • MCP menjembatani kesenjangan antara Cursor dan sistem internal Anda
  • Hasilkan dokumentasi dari kode dan percakapan untuk menjaga pengetahuan tetap terkini
  • Gabungkan sumber dokumentasi eksternal dan internal untuk pemahaman yang komprehensif