Teknik Dokümantasyon Yazımı

💬 Prompt

Aşağıdaki ürün/sistem için profesyonel teknik dokümantasyon yaz:

ÜRÜN/SİSTEM: [ÜRÜN ADI]
DİSİPLİN: [YAZILIM / MAKİNE / ELEKTRİK / İNŞAAT / KİMYA / ENDÜSTRİ]
KULLANICI TİPİ: [SON KULLANICI / TEKNİSYEN / MÜHENDİS / YÖNETİCİ]
KARMAŞIKLIK: [BASIT / ORTA / KARMAŞIK SISTEM]
STANDART: [ISO / IEEE / ASTM / TSE / CE]
DİL: [TÜRKÇE / İNGİLİZCE / İKİ DİLLİ]

3 katmanlı dokümantasyon yapısı:

KATMAN 1 — KULLANICI KILAVUZU (user manual)

HEDEF: Son kullanıcı sistemi güvenli ve etkin kullansın
UZUNLUK: 20-60 sayfa

BÖLÜMLER:

1. KAPAK VE KİMLİK
- Ürün adı, model, seri no
- Sürüm numarası + tarih
- Üretici bilgileri
- Güvenlik sembolleri (ISO 3864)

2. HIZLI BAŞLANGIÇ (1-2 sayfa)
- 5 kritik adım
- İlk kullanımdan önce kontrol
- İletişim (sorun olursa kim)

3. GÜVENLİK UYARILARI
- TEHLİKE / UYARI / DİKKAT / NOT (ANSI Z535)
- Elektriksel riskler
- Mekanik riskler
- Kimyasal maruziyet
- Kişisel koruyucu ekipman (KKE)
- Acil durum prosedürü

4. ÜRÜN TANITIMI
- Ne işe yarar (1 paragraf)
- Ana bileşenler (etiketli şema)
- Teknik özellikler özeti (tablo)
- Çalışma prensibi (basit dilde)

5. KURULUM
- Gerekli araç listesi
- Adım adım kurulum (fotoğraflı)
- Çevresel gereksinimler (ısı, nem, havalandırma)
- Bağlantı şemaları

6. KULLANIM
- Temel işlemler
- İleri işlevler
- Ekran/panel açıklamaları
- Ayarlar ve kalibrasyon

7. BAKIM
- Günlük/haftalık/aylık bakım
- Sarf malzeme değişimi
- Sorun giderme tablosu (şikayet → olası sebep → çözüm)

8. ARIZA ÇÖZME (troubleshooting)
- Ortak 15-20 problem
- Her birine adım adım çözüm
- Ne zaman servise çağır

9. GARANTI VE SERVIS
- Garanti kapsamı
- İletişim
- Yedek parça siparişi

10. EKLER
- Teknik veri sayfası
- Uygunluk beyanı (CE, FCC)
- İade formu

KATMAN 2 — TEKNİK KILAVUZ (technical manual)

HEDEF: Teknisyen kurulum, onarım, yedek parça değişimi yapabilsin
UZUNLUK: 80-200 sayfa

EK BÖLÜMLER (kullanıcı kılavuzundan farklı):
- Detaylı sistem şemaları (elektrik, mekanik, yazılım)
- Patlayış görünümleri (exploded view)
- Yedek parça listesi (parça numaraları)
- Test prosedürleri
- Kalibrasyon prosedürleri
- Firmware/yazılım güncelleme
- Diyagnostik kodları (error codes tablosu)
- Devre şemaları (PCB layout)
- Mekanik çizimler (AutoCAD/SolidWorks export)
- API dokümantasyonu (yazılım ise)

KATMAN 3 — MÜHENDİSLİK BELGELERİ (engineering documentation)

HEDEF: Tasarım mantığı, karar geçmişi, revizyon kontrolü
UZUNLUK: değişken

1. DESIGN SPECIFICATION (tasarım spesifikasyonu)
- Gereksinim analizi
- Tasarım seçenekleri + karşılaştırma
- Seçilen tasarımın gerekçesi
- Performans kriterleri

2. FMEA (Failure Mode and Effects Analysis)
- Arıza modları
- Etki analizi
- Risk öncelik sayısı (RPN)
- Azaltma önlemleri

3. TEST RAPORLARI
- Test planı
- Test sonuçları
- Uygunluk beyanı
- Sertifikasyon belgeleri

4. DESIGN REVIEW KAYITLARI
- Gate review (PDR, CDR)
- Katılımcılar
- Alınan kararlar
- Açık konular

5. REVİZYON GEÇMİŞİ
- Her revizyon için: tarih, yazan, değişen bölüm, neden
- Eski versiyonlara geri dönüş imkanı

YAZIM KALITESI:

CLEAR ENGLISH / TURKISH
- Kısa cümleler (max 25 kelime)
- Aktif ses ("Operator presses button" > "Button is pressed")
- Adım başına 1 aksiyon
- Numaralama + görsel hiyerarşi
- Jargon yok (ya da ilk geçişte açıkla)

GÖRSELLER
- Her 2 sayfada bir şekil/grafik
- Foto: 300 dpi, iyi aydınlatma
- Çizim: vector SVG/EPS tercih
- Her görselin altında açıklama
- Renk körü dostu (paten + renk)

FORMAT
- A4 standart
- Times New Roman / Arial 11pt
- 1.5 line spacing
- Kenar boşluğu: 2.5 cm
- Başlık hiyerarşisi tutarlı
- PDF/A (uzun süreli arşiv)

DİL KONTROL
- Teknik terim sözlüğü (glossary)
- TR-EN karşılık tablosu
- Tutarlı terminoloji (aynı kavrama aynı kelime)

STANDARTLARA UYUM:

- IEEE 1063 (Yazılım kullanıcı kılavuzu)
- ISO/IEC 26514 (Yazılım dokümantasyonu)
- IEC 82079-1 (Kullanım talimatları genel)
- ASME Y14 (Mühendislik çizimleri)
- TSE/CE uyumluluğu (Türkiye/AB)

ÖZEL NOTLAR:
- KVKK uyumu (kullanıcı verisi işleyen sistemlerde)
- Erişilebilirlik (görme/işitme engelli kullanıcılar)
- Çok dilli sürüm stratejisi
- PDF + HTML + basılı format senkronizasyonu

Türkçe. Mühendislik profesyonelliğinde.

📝 Örnek Çıktı