komunite Api Documentation
Amaç
Eyleme dönüştürülebilir, ölçülebilir sonuçlar sunan kapsamlı bir api documentation oluşturun. Bu beceri, her seferinde profesyonel düzeyde çıktı sağlayan, kalite doğrulamalı yapılandırılmış bir süreç sunar.
Kategori: İçerik ve Metin Yazarlığı & Copywriting
Girdiler
Zorunlu
- Hedef: Bu çıktı ile neyi başarmak istiyorsunuz
- Target Audience: Who this is for (demographics, psychographics, pain points)
İsteğe Bağlı
- Brand Voice: Tone and style guidelines (check knowledge-base for existing)
- Competitors: Key competitors to differentiate from
Sistem Bağlamı
Başlamadan önce:
- Mevcut proje bağlamı ve öncelikleri için
memory.md'yi oku - İlgili öğrenilmiş kurallar veya kısıtlamalar için
knowledge-base.md'yi kontrol et - Projedeki mevcut ilgili belgeleri gözden geçir
- Bu çıktı ile ilgili
.claude/workspace/TaskBoard.md'deki aktif görevleri not et
Süreç
Adım 1: Bağlam ve Araştırma
- Projedeki mevcut api documentation belgelerini gözden geçir
- İlgili öğrenilmiş kurallar veya kısıtlamalar için
knowledge-base.md'yi kontrol et - Mevcut proje bağlamı ve öncelikleri için
memory.md'yi kontrol et - Kilit paydaşları ve gereksinimlerini belirle
- En uygun çerçeveyi seç: AIDA for copy, PAS (Problem-Agitate-Solve), BAB (Before-After-Bridge)
Adım 2: Analiz ve Çerçeve Uygulaması
- api documentation yapılandırmak için seçilen çerçeveyi uygula
- Boşlukları, fırsatları ve riskleri belirle
- Başarı metriklerini tanımla: Readability Score (Flesch-Kincaid 60+), Time on Page, Scroll Depth, Social Shares
- Varsayımları ve bağımlılıkları belgele
- Yaklaşımı sektör en iyi uygulamalarına göre doğrula
Adım 3: Çıktıyı Oluştur
- api documentation aşağıdaki çıktı formatını kullanarak yapılandır
- Genel tavsiyeler değil, spesifik ve eyleme dönüştürülebilir öneriler ekle
- Uygulanabilir yerlerde somut rakamlar, zaman çizelgeleri ve kıyaslamalar ekle
- Tutarlılık için mevcut proje belgeleriyle çapraz referans yap
- Her bölümün değer kattığından emin ol — dolgu içeriği çıkar
Adım 4: Kalite Doğrulama
- Tüm zorunlu girdiler ele alındı
- Öneriler spesifik ve eyleme dönüştürülebilir (belirsiz değil)
- Rakamlar ve kıyaslamalar gerçekçi ve kaynaklı
- Çıktı formatı aşağıdaki spesifikasyona uyuyor
- Bilgi tabanı kurallarıyla çelişki yok
- En iyi pratiği izliyor: Write at 8th grade reading level for general audiences
Çıktı Formatı
# Api Documentation
## Yönetici Özeti
[Çıktının ve temel önerilerin 2-3 cümlelik özeti]
## Bağlam ve Hedefler
- **Hedef**: [Bunun neyi başardığı]
- **Hedef Kitle**: [Bunun kimin için olduğu]
- **Zaman Çizelgesi**: [Bunun ne zaman geçerli olduğu]
## Analiz
[Seçilen çerçeve kullanılarak yapılandırılmış analiz]
## Öneriler
1. [Beklenen etkisiyle spesifik, eyleme dönüştürülebilir öneri]
2. [Beklenen etkisiyle spesifik, eyleme dönüştürülebilir öneri]
3. [Beklenen etkisiyle spesifik, eyleme dönüştürülebilir öneri]
## Uygulama
| Eylem | Sorumlu | Zaman Çizelgesi | Öncelik |
|--------|-------|----------|----------|
| [Eylem maddesi] | [Kim] | [Ne zaman] | [Yüksek/Orta/Düşük] |
## Başarı Metrikleri
| Metrik | Mevcut | Hedef | Ölçüm Yöntemi |
|--------|---------|--------|-------------------|
| [KPI] | [Başlangıç] | [Hedef] | [Nasıl ölçülür] |
## Riskler ve Azaltmalar
| Risk | Olasılık | Etki | Azaltma |
|------|-----------|--------|------------|
| [Risk] | [Y/O/D] | [Y/O/D] | [Eylem] |
## Sonraki Adımlar
- [ ] [Hemen yapılacak eylem]
- [ ] [Takip eylemi]
- [ ] [Gözden geçirme tarihi]
Uygulanabilir Çerçeveler
- AIDA for copy
- PAS (Problem-Agitate-Solve)
- BAB (Before-After-Bridge)
- Inverted Pyramid
- Hub and Spoke content model
- Content Atomization
- StoryBrand
Temel Metrikler
- Readability Score (Flesch-Kincaid 60+)
- Time on Page
- Scroll Depth
- Social Shares
- Backlinks Generated
- Conversion Rate from Content
En İyi Pratikler
- Write at 8th grade reading level for general audiences
- One idea per paragraph, max 3 sentences
- Front-load the value — answer the question in the first 100 words
- Use active voice (90%+ of sentences)
- Every piece needs a clear CTA
Tamamlandıktan Sonra
- Bu çıktı proje bağlamını veya önceliklerini değiştiriyorsa
memory.md'yi güncelle - Yeniden kullanılabilir öğrenmeleri
knowledge-nominations.md'ye ekle - Takip eylemleri belirlendiyse bunları
.claude/workspace/TaskBoard.md'ye ekle - Ek çalışma gerekiyorsa ilgili skill'leri öner