---

🟢 1. Pendahuluan

Dalam dunia Informatika dan Sistem Informasi, dokumentasi merupakan bagian penting dalam pengembangan teknologi. Sebuah aplikasi, sistem informasi, jaringan komputer, maupun software tidak hanya membutuhkan proses coding, tetapi juga membutuhkan dokumen yang menjelaskan cara kerja, prosedur penggunaan, spesifikasi sistem, dan panduan teknis lainnya.

Penulisan dokumen teknis menjadi kemampuan penting yang harus dimiliki mahasiswa IT agar mampu menyampaikan informasi teknis secara jelas, sistematis, dan mudah dipahami.

---

🟢 2. Pengertian Dokumen Teknis

📌 Definisi Dokumen Teknis

Dokumen teknis adalah dokumen yang berisi informasi teknis mengenai sistem, perangkat, aplikasi, prosedur, atau teknologi tertentu yang ditulis secara sistematis dan profesional.

---

🔍 Narasi:

Dokumen teknis membantu pengguna, developer, maupun organisasi memahami sistem yang dibuat. Dokumentasi yang baik dapat mempermudah:

• Penggunaan sistem
• Pemeliharaan aplikasi
• Pengembangan lanjutan
• Pelatihan pengguna
• Troubleshooting

---

🖼️ Ilustrasi Dokumentasi Teknologi

7

---

🟢 3. Tujuan Penulisan Dokumen Teknis

📊 Tabel Tujuan Dokumentasi

Tujuan	Penjelasan
Informasi	Menjelaskan sistem
Panduan	Membantu penggunaan
Referensi	Dokumentasi pengembangan
Pemeliharaan	Mempermudah maintenance
Standarisasi	Menjaga konsistensi

---

🔍 Narasi:

Dalam proyek IT, dokumentasi yang buruk dapat menyebabkan kesalahan penggunaan sistem dan kesulitan pengembangan di masa depan.

---

🟢 4. Karakteristik Dokumen Teknis yang Baik

📌 Ciri-Ciri Dokumen Teknis

✅ Jelas

Bahasa mudah dipahami.

✅ Sistematis

Memiliki struktur teratur.

✅ Akurat

Informasi sesuai fakta.

✅ Lengkap

Memuat informasi penting.

✅ Konsisten

Menggunakan format seragam.

---

📊 Tabel Karakteristik

Karakteristik	Penjelasan
Jelas	Mudah dipahami
Sistematis	Terstruktur
Akurat	Tidak ambigu
Lengkap	Informasi cukup
Konsisten	Format stabil

---

🟢 5. Jenis-Jenis Dokumen Teknis

📌 A. User Manual

Panduan penggunaan aplikasi atau sistem.

Contoh:

• Panduan login aplikasi
• Cara menggunakan fitur sistem

---

📌 B. SOP (Standard Operating Procedure)

Dokumen prosedur standar kerja.

Contoh:

• SOP backup database
• SOP maintenance server

---

📌 C. Dokumentasi Sistem

Menjelaskan struktur dan alur sistem.

Contoh:

• Flowchart
• ERD
• UML
• Arsitektur sistem

---

📌 D. Laporan Teknis

Laporan hasil analisis atau pengembangan.

Contoh:

• Laporan proyek software
• Laporan keamanan jaringan

---

📌 E. API Documentation

Dokumentasi layanan API.

Contoh:

• Endpoint API
• Request dan response

---

🖼️ Jenis Dokumen Teknis

8

---

🟢 6. Struktur Penulisan Dokumen Teknis

📊 Struktur Dokumen

Judul
  ↓
Pendahuluan
  ↓
Tujuan
  ↓
Isi/Pembahasan
  ↓
Diagram/Gambar
  ↓
Kesimpulan
  ↓
Lampiran

---

📌 Penjelasan Struktur

1️⃣ Judul

Menjelaskan isi dokumen.

2️⃣ Pendahuluan

Berisi latar belakang.

3️⃣ Tujuan

Menjelaskan fungsi dokumen.

4️⃣ Isi/Pembahasan

Penjelasan teknis utama.

5️⃣ Diagram/Gambar

Visualisasi sistem atau prosedur.

6️⃣ Kesimpulan

Ringkasan isi dokumen.

---

🟢 7. Bahasa dalam Dokumen Teknis

📌 Karakteristik Bahasa Teknis

✅ Formal

Menggunakan bahasa resmi.

✅ Efektif

Kalimat tidak bertele-tele.

✅ Objektif

Tidak bersifat emosional.

✅ Spesifik

Informasi jelas dan detail.

---

📊 Contoh Penulisan

Tidak Efektif	Efektif
Sistem lumayan cepat	Sistem memproses data dalam 2 detik
Server kadang error	Server mengalami downtime 5%

---

🔍 Narasi:

Dokumen teknis harus menghindari bahasa ambigu agar mudah dipahami semua pihak.

---

🟢 8. Penggunaan Diagram dan Visualisasi

📌 Pentingnya Visualisasi

Visual membantu pembaca memahami sistem lebih cepat dibanding teks panjang.

---

📌 Jenis Diagram dalam Dokumentasi

📊 Flowchart

Menjelaskan alur proses.

📈 UML

Menjelaskan desain sistem.

🗄️ ERD

Menjelaskan struktur database.

🌐 Network Diagram

Menjelaskan jaringan komputer.

---

🖼️ Diagram Sistem dan Dokumentasi

6

---

🟢 9. Dokumentasi dalam Proyek IT

📌 Peran Dokumentasi dalam Pengembangan Sistem

Dokumentasi diperlukan pada setiap tahap:

• Analisis kebutuhan
• Desain sistem
• Implementasi
• Testing
• Maintenance

---

📊 Siklus Dokumentasi Sistem

Analisis
   ↓
Desain
   ↓
Coding
   ↓
Testing
   ↓
Deployment
   ↓
Maintenance

---

🔍 Narasi:

Tanpa dokumentasi, pengembangan sistem akan sulit dilanjutkan oleh tim lain.

---

🖼️ Tim Developer dan Dokumentasi

8

---

🟢 10. Tools Penulisan Dokumen Teknis

📊 Tabel Tools Dokumentasi

Tools	Fungsi
Microsoft Word	Penulisan dokumen
Google Docs	Kolaborasi online
Notion	Dokumentasi modern
Draw.io	Membuat diagram
Lucidchart	Flowchart/UML
Swagger	API Documentation

---

🖼️ Tools Dokumentasi Digital

8

---

🟢 11. Kesalahan Umum dalam Dokumentasi

📊 Tabel Kesalahan

Kesalahan	Dampak
Bahasa ambigu	Sulit dipahami
Tidak ada diagram	Membingungkan
Struktur tidak rapi	Sulit dibaca
Informasi kurang lengkap	Menimbulkan error
Tidak update	Informasi tidak relevan

---

🟢 12. Teknik Menulis Dokumentasi yang Efektif

📌 Tips Penulisan

✅ Gunakan Heading/Subheading

✅ Gunakan Bullet Point

✅ Tambahkan Diagram

✅ Gunakan Screenshot

✅ Gunakan Bahasa Ringkas

✅ Fokus pada User

---

🔍 Narasi:

Dokumentasi yang baik harus mudah dibaca oleh user teknis maupun non-teknis.

---

🟢 13. Tutorial / Praktikum

💻 Praktikum 1 — Membuat User Manual

📌 Tugas:

Buat panduan penggunaan aplikasi sederhana.

---

Isi Manual:

1️⃣ Halaman Judul

2️⃣ Tujuan Sistem

3️⃣ Cara Login

4️⃣ Penjelasan Menu

5️⃣ Cara Input Data

6️⃣ Logout

---

💻 Praktikum 2 — Membuat Flowchart Sistem

📌 Gunakan:

• Draw.io
• Lucidchart
• Visio

---

Contoh Alur

Login
  ↓
Dashboard
  ↓
Input Data
  ↓
Simpan
  ↓
Laporan

---

💻 Praktikum 3 — Menulis SOP Backup Database

📌 Struktur SOP

1️⃣ Tujuan

2️⃣ Alat dan Sistem

3️⃣ Langkah Backup

4️⃣ Verifikasi Backup

5️⃣ Dokumentasi Hasil

---

🟢 14. Studi Kasus

📌 Kasus:

Sebuah perusahaan mengalami kesulitan maintenance aplikasi karena developer lama tidak membuat dokumentasi sistem.

---

🔍 Dampak:

• Sulit memahami alur sistem
• Maintenance lama
• Banyak error
• Ketergantungan pada developer lama

---

🎯 Solusi:

✅ Membuat dokumentasi lengkap

✅ Menyusun SOP sistem

✅ Dokumentasi database

✅ Dokumentasi API

---

🟢 15. Latihan dan Diskusi

✏️ Latihan Individu

1. Jelaskan pengertian dokumen teknis!
2. Sebutkan jenis-jenis dokumentasi teknis!
3. Mengapa dokumentasi penting dalam proyek IT?
4. Jelaskan fungsi flowchart!
5. Sebutkan tools dokumentasi digital!

---

👥 Diskusi Kelompok

Tema:

“Pentingnya Dokumentasi dalam Pengembangan Sistem Informasi”

Bahas:

• Dampak dokumentasi buruk
• Standarisasi dokumentasi
• Kolaborasi developer
• Maintenance sistem

---

🟢 16. Kesimpulan

Penulisan dokumen teknis merupakan keterampilan penting dalam dunia Informatika dan Sistem Informasi. Dokumentasi yang baik membantu proses pengembangan, penggunaan, maintenance, dan pengelolaan sistem teknologi secara profesional.

Mahasiswa IT harus mampu membuat dokumentasi yang:

• Jelas
• Sistematis
• Informatif
• Visual
• Mudah dipahami

Kemampuan dokumentasi yang baik akan sangat berguna dalam:

• Dunia kerja
• Pengembangan software
• Proyek startup
• Penelitian
• Industri teknologi modern