AI Prompt Engineering · Pelajaran

Perintah untuk Dokumentasi Teknis

Buat file README, dokumentasi API, dan panduan cara melakukan sesuatu dengan gaya teknis yang akurat.

Pelajaran 3 dari 413 langkah

Perintah untuk Dokumentasi Teknis adalah pelajaran AI Prompt Engineering gratis di CoddyKit. Ini adalah pelajaran 3 dari 4. Kamu bisa membaca pelajaran lengkapnya di bawah secara gratis — lalu praktikkan langsung di browser dengan editor kode bawaan dan tutor AI 24/7. Ini adalah bagian dari jalur belajar AI Prompt Engineering, dan progresmu tersinkronisasi di web dan aplikasi CoddyKit. Kursus AI Prompt Engineering mencakup 4 pelajaran total.

Dokumentasi Teknis Adalah Sebuah Genre

Dokumentasi teknis adalah genre penulisan tersendiri dengan konvensi khusus: mengutamakan ketepatan daripada gaya, struktur daripada narasi, dan kelengkapan daripada keringkasan. Prompt yang sesuai untuk tulisan blog atau email akan menghasilkan ragam bahasa yang keliru untuk dokumentasi teknis.

Prompt dokumentasi teknis yang efektif menyatakan genre secara eksplisit — jenis dokumen, tingkat pengetahuan pembaca yang diasumsikan, struktur standar untuk jenis dokumen tersebut, dan konvensi penggunaan sudut pandang (biasanya orang kedua untuk panduan langkah demi langkah dan orang ketiga untuk dokumen referensi).

Prompt Berkas README

README adalah titik awal sebuah proyek. Struktur standarnya sudah mapan. Prompt README yang efektif menentukan setiap bagian:

Nama proyek dan deskripsi satu baris
Fungsinya: 2–3 kalimat tentang tujuan
Prasyarat: hal-hal yang perlu dipasang
Instalasi: langkah-langkah bernomor beserta perintah
Mulai cepat: contoh kerja minimal
Konfigurasi: variabel lingkungan dan opsi
Berkontribusi: cara mengirimkan PR
Lisensi

Menyediakan semua nama bagian dalam prompt akan menghasilkan README yang lengkap. Bagian yang tidak disebutkan akan dihilangkan jika tidak ada instruksi eksplisit.

Prompt README dalam Kode

Pembangkit README terstruktur yang menerima metadata proyek:

import openai

client = openai.OpenAI(api_key='sk-...')

def generate_readme(project_name, description, language, dependencies,
                    install_steps, quick_start_example, config_vars, license_type):

    prompt = f'''Write a README.md for the following project.

Project name: {project_name}
Description: {description}
Language/stack: {language}
Dependencies: {dependencies}
Installation steps: {install_steps}
Quick start example: {quick_start_example}
Key configuration variables: {config_vars}
License: {license_type}

Structure the README with these sections in order:
1. Project title and badge line (GitHub stars, license)
2. One-sentence description
3. Features (3-5 bullet points)
4. Prerequisites
5. Installation (numbered steps with code blocks)
6. Quick Start (minimal working example in a code block)
7. Configuration (table: Variable | Description | Default)
8. Contributing (2-3 sentences)
9. License

Voice: second person imperative for steps ("Run...", "Install...").
Code blocks: use correct language identifiers.
Do not add placeholder content — only include sections where I provided information.'''

    response = client.chat.completions.create(
        model='gpt-4o-mini',
        messages=[{'role': 'user', 'content': prompt}]
    )
    return response.choices[0].message.content

Prompt Dokumentasi API

Dokumentasi API memiliki struktur yang kaku. Setiap entri titik akhir memerlukan: metode HTTP, jalur, deskripsi, parameter, isi permintaan, format respons, kode kesalahan, dan contoh. Prompt harus menentukan semuanya:

"Tulis dokumentasi API untuk titik akhir REST. Sertakan: metode (POST), jalur (/api/v1/users), deskripsi, tabel parameter (nama, jenis, wajib, deskripsi), contoh JSON isi permintaan, contoh JSON respons berhasil (200), respons kesalahan (400, 401, 422) beserta contoh JSON. Gaya bahasa: orang ketiga, kala kini. Gunakan tabel markdown untuk parameter."

Setiap elemen struktural harus disebutkan secara eksplisit — model tidak akan menebak standar dokumentasi Anda.

Prompt Panduan Cara

Panduan cara bersifat prosedural: panduan ini membawa pembaca dari keadaan A (masalah) ke keadaan B (solusi) melalui langkah-langkah bernomor. Elemen prompt untuk panduan cara:

Prasyarat: hal-hal yang harus sudah terpenuhi sebelum memulai
Hasil: hal yang akan berhasil dicapai pembaca
Langkah-langkah: bernomor, masing-masing berisi satu tindakan — bukan beberapa tindakan dalam satu langkah
Contoh kode: satu contoh untuk setiap langkah jika relevan, dengan bahasa yang dicantumkan
Validasi: cara pembaca mengetahui bahwa setiap langkah berhasil
Pemecahan masalah: mode kegagalan umum untuk dua atau tiga langkah yang paling rumit

Keakuratan Teknis dalam Prompt Dokumentasi

Dokumentasi teknis memiliki tuntutan keakuratan yang lebih tinggi daripada kebanyakan jenis konten. Berikut dua teknik untuk meningkatkan keakuratan dalam prompt dokumentasi:

Berikan kode yang sebenarnya: tempelkan tanda tangan fungsi, opsi konfigurasi, atau spesifikasi API yang nyata. Dengan demikian, model mendokumentasikan hal-hal yang benar-benar ada, bukan mengarang detail.

Minta langkah verifikasi: "Setelah menulis setiap langkah, catat asumsi apa pun yang Anda buat tentang lingkungan pengguna atau perilaku sistem. Tandai hal-hal yang harus saya verifikasi sebelum menerbitkannya."

Jangan pernah menggunakan dokumentasi yang dihasilkan AI tanpa peninjauan teknis — model dapat dengan yakin mendokumentasikan hal-hal yang sebenarnya tidak ada atau tidak benar.

Kualitas Contoh Kode dalam Dokumentasi

Contoh kode adalah elemen terpenting dalam dokumentasi teknis. Minta contoh tersebut secara eksplisit:

"Sertakan satu contoh kode yang berfungsi untuk setiap konsep utama. Contoh harus mandiri — pembaca harus dapat menyalin, menempelkan, dan menjalankannya."
"Tunjukkan penggunaan yang benar dan kesalahan umum, disertai komentar yang menjelaskan alasan kesalahan tersebut gagal."
"Contoh kode harus menggunakan nama variabel dan data yang realistis, bukan 'foo', 'bar', 'uji'."
"Bahasa: Python 3.11. Gunakan petunjuk tipe. Sertakan penanganan kesalahan untuk panggilan jaringan."

Tanpa instruksi contoh kode yang eksplisit, model mungkin menghasilkan potongan kode semu yang tidak lengkap dan sebenarnya tidak dapat dijalankan.

Suara dan Gaya Dokumentasi

Dokumentasi teknis memiliki gaya bahasa khusus yang berbeda dari jenis tulisan lainnya:

Kalimat imperatif orang kedua untuk prosedur: "Klik Pengaturan. Pilih tab API. Masukkan kunci Anda."
Orang ketiga untuk dokumentasi referensi: "Metode authenticate() mengembalikan token Bearer yang berlaku selama 24 jam."
Bentuk waktu kini: "Fungsi mengembalikan...", bukan "Fungsi akan mengembalikan..."
Tanpa bahasa yang meragukan: "Jalankan perintah ini", bukan "Anda mungkin ingin mempertimbangkan untuk menjalankan perintah ini"
Terminologi yang konsisten: gunakan istilah yang sama untuk konsep yang sama di seluruh dokumen — jangan gunakan sinonim

Prompt Catatan Perubahan dan Catatan Rilis

Catatan perubahan dan catatan rilis memiliki format konvensional yang harus ditetapkan dalam prompt:

"Tulis catatan rilis untuk versi 2.3.0. Format: tajuk versi, tanggal rilis, lalu tiga bagian: 'Ditambahkan' (fitur baru), 'Diubah' (modifikasi pada fitur yang sudah ada), 'Diperbaiki' (perbaikan bug). Setiap item: satu baris, gunakan kalimat aktif, diawali kata kerja. Audiens: pengembang yang mengintegrasikan pustaka ini. Nada: tepat dan netral — tanpa bahasa pemasaran. Berikut perubahan yang terjadi: [daftar perubahan sebenarnya]."

Memberikan perubahan sebenarnya sebagai data masukan memastikan keakuratan. Tanpa data tersebut, model akan mengarang catatan rilis yang terdengar masuk akal tetapi fiktif.

Pemeriksaan Kelengkapan Dokumentasi

Setelah menghasilkan dokumentasi teknis, jalankan prompt pemeriksaan kelengkapan:

import openai

client = openai.OpenAI(api_key='sk-...')

def check_documentation_completeness(doc_text, doc_type='how-to guide'):
    checklist = {
        'how-to guide': [
            'Prerequisites stated?',
            'Expected outcome stated?',
            'Each step is a single action?',
            'Code examples included where relevant?',
            'Validation step for each major action?',
            'Common errors addressed?'
        ],
        'readme': [
            'One-line description present?',
            'Installation steps numbered with commands?',
            'Quick start example included?',
            'Configuration variables documented?',
            'License specified?'
        ]
    }

    items = checklist.get(doc_type, [])
    check_prompt = f'Review this {doc_type} and answer each question (Yes/No + brief note):\n'
    for item in items:
        check_prompt += f'- {item}\n'
    check_prompt += f'\nDocument:\n{doc_text[:2000]}'

    response = client.chat.completions.create(
        model='gpt-4o-mini',
        messages=[{'role': 'user', 'content': check_prompt}]
    )
    return response.choices[0].message.content

Menerjemahkan Jargon untuk Audiens Campuran

Dokumentasi teknis sering kali perlu melayani pembaca teknis dan nonteknis. Berikut pola prompt yang praktis:

"Tulis dokumentasi ini dalam dua lapisan. Lapisan pertama: ringkasan nonteknis dalam 3 kalimat (apa fungsinya, mengapa penting, kapan digunakan). Lapisan kedua: spesifikasi teknis lengkap. Gunakan pemisah visual yang jelas di antara kedua lapisan. Dengan demikian, manajer nonteknis dapat membaca ringkasan lalu berhenti; pembaca teknis dapat melewati ringkasan dan membaca spesifikasinya."

Dokumentasi dua lapisan lebih berguna daripada mencoba menulis satu versi yang tidak memadai untuk kedua audiens.

Pemeriksaan Pengetahuan: Prompt Dokumentasi Teknis

Anda sedang menulis prompt untuk menghasilkan dokumentasi API bagi 50 titik akhir. Persyaratan kualitas yang paling penting adalah dokumentasi tersebut secara akurat mencerminkan hal yang benar-benar dilakukan API, bukan hal yang dibayangkan model. Pendekatan mana yang paling menjamin keakuratan?

Jawab di pelajaran interaktif

Rangkuman: Prompt Dokumentasi Teknis

Dokumentasi teknis adalah genre khusus yang memerlukan ketepatan, struktur, dan gaya imperatif orang kedua untuk prosedur. Prompt yang efektif menetapkan jenis dokumen, bagian yang diperlukan berdasarkan nama, persyaratan contoh kode (mandiri, dengan nama variabel realistis, serta versi bahasa), dan konvensi gaya bahasa dokumentasi.

Teknik keakuratan yang paling penting: selalu berikan kode, spesifikasi API, atau data konfigurasi yang sebenarnya sebagai masukan — jangan pernah meminta model mengarang detail teknis. Selalu lakukan peninjauan teknis oleh manusia sebelum menerbitkan dokumentasi yang dihasilkan AI.

Dalam pelajaran terakhir, Anda akan menerapkan teknik penyusunan prompt pada konten kreatif dan penceritaan.

Gratis untuk memulai

Belajar AI Prompt Engineering dengan tutor AI — gratis

Tulis dan jalankan kode asli di browser kamu, dapatkan bantuan instan dari tutor AI 24/7, dan lanjutkan di mana kamu tinggalkan di web atau aplikasi.

Kursus: 53
Pelajaran: 199

Mulai belajar gratis Lihat kursus lengkapnya

Pertanyaan yang Sering Diajukan

Apakah pelajaran “Perintah untuk Dokumentasi Teknis” gratis?

Ya — teks lengkap “Perintah untuk Dokumentasi Teknis” gratis dibaca di sini di web. Untuk praktiknya secara interaktif (editor kode bawaan dan tutor AI 24/7) dan buka sisa kursus AI Prompt Engineering, upgrade ke CoddyKit PRO. Kursus AI Prompt Engineering mencakup 4 pelajaran total.

Apa yang akan aku pelajari di “Perintah untuk Dokumentasi Teknis”?

Buat file README, dokumentasi API, dan panduan cara melakukan sesuatu dengan gaya teknis yang akurat. Kamu berlatih AI Prompt Engineering dengan kode praktik yang langsung kamu jalankan di browser, dan tutor AI 24/7 menjawab pertanyaanmu saat kamu mengerjakan pelajaran ini.

Apakah aku perlu pengalaman untuk memulai AI Prompt Engineering?

Tidak diperlukan pengalaman sebelumnya. AI Prompt Engineering di CoddyKit dirancang untuk pemula hingga pelajar tingkat lanjut, jadi kamu bisa memulai di sini atau dari awal dan belajar sesuai kecepatan kamu sendiri. Ini adalah pelajaran 3 dari 4.

Berapa lama pelajaran “Perintah untuk Dokumentasi Teknis” memakan waktu?

Sebagian besar pelajaran CoddyKit memakan waktu sekitar 5–10 menit. Setiap pelajaran ringkas dan interaktif, jadi kamu membuat kemajuan stabil dan melanjutkan dari tempat kamu tinggalkan di web dan aplikasi.

Bisakah aku menulis dan menjalankan kode dalam pelajaran AI Prompt Engineering ini?

Ya. Setiap pelajaran AI Prompt Engineering menyertakan editor kode bawaan, jadi kamu menulis dan menjalankan kode nyata langsung di browser dan mendapatkan umpan balik AI instan — tidak diperlukan penyiapan lokal.

Semua pelajaran dalam kursus ini

Perintah untuk Email dan Penulisan Profesional
Perintah untuk Konten Media Sosial
Perintah untuk Dokumentasi Teknis
Perintah Kreatif dan Penceritaan

← Kembali ke AI Prompt Engineering