📄 14.3 – README Dosyası Yazımı
🎯
Amaç:
Bir proje teslim edilirken, projeyi inceleyecek kişi (öğretmen, jüri, başka bir geliştirici) projenin ne olduğunu, nasıl çalıştığını ve hangi dosyaların ne işe yaradığını hızlıca anlamalıdır.
İşte bu ihtiyacı karşılamak için README dosyası yazılır.
📁
Dosya Türü ve Konumu:
| Özellik | Detay |
|---|---|
| Dosya Adı | README.txt veya README.md |
| Konum | Proje ana dizininde, .sln dosyasının yanında |
🧱
README Dosyası İçeriği:
Aşağıdaki gibi sade, anlaşılır, madde madde yazılmalıdır:
📌
Örnek README.txt İçeriği
PROJE ADI: Öğrenci Takip Sistemi
GELİŞTİREN: Mehmet Selim YILMAZ
SINIF: 10/B Bilişim Teknolojileri
TARİH: Haziran 2025
AÇIKLAMA:
Bu proje, C# Windows Forms kullanılarak geliştirilmiştir.
Katmanlı mimari yapısı kullanılarak öğrencilerin bilgileri kaydedilir, listelenir ve yönetilir.
Uygulama dosyaları bin\Release klasöründedir.
KULLANILAN KATMANLAR:
- Entity: Ogrenci.cs sınıfı
- Business: OgrenciManager.cs sınıfı (veri işlemleri)
- UI: Form1.cs (kullanıcı arayüzü)
VERİ DOSYASI:
ogrenciler.txt → Form üzerinden girilen bilgiler burada saklanır.
ÇALIŞTIRMA TALİMATI:
1. bin\Release klasörüne gidin
2. “OgrenciTakip.exe” dosyasına çift tıklayın
3. Gerekli veri dosyaları klasör içerisinde hazırdır
NOT:
Uygulama ilk açıldığında dosya yoksa otomatik olarak oluşturur.✍️
README Yazarken Dikkat Edilecekler:
✅ Açık, kısa, sade bir dil kullanın
✅ Tüm katmanları ve ana dosyaları açıklayın
✅ Kullanıcıya adım adım nasıl çalıştıracağını anlatın
✅ Varsa özel gereksinimler (.NET sürümü, veritabanı, ek dll vs.) belirtilmeli
🔧
Gelişmiş README.md (Markdown) Formatı Kullanmak İstersen:
# Öğrenci Takip Sistemi
## Geliştiren
Mehmet Selim YILMAZ – 10/B Bilişim Teknolojileri
## Açıklama
Bu proje, C# Windows Forms ile katmanlı mimari kullanılarak geliştirilmiştir. Kullanıcılar öğrenci bilgilerini ekleyebilir, güncelleyebilir ve listeleyebilir.
## Yapı
- **Entity:** `Ogrenci.cs`
- **Business:** `OgrenciManager.cs`
- **UI:** `Form1.cs`
## Nasıl Çalıştırılır?
1. `bin/Release` klasörüne gidin
2. `OgrenciTakip.exe` dosyasını çalıştırın
3. Veri dosyaları proje ile birlikte gelir
## Dosyalar
- `ogrenciler.txt`: Öğrenci bilgileri bu dosyaya yazılır
## Not
İlk çalıştırmada dosya otomatik oluşturulur.
