Geliştir Entegre Et
Ek değer yaratmak için ürünün üzerine inşa edin, onu genişletin veya entegre edin.
Kullanıcıların çoğu zaman mevcut ürünlerin üzerine bir şeyler inşa etmesi, onları genişletmesi veya başka sistemlerle bütünleştirmesi gerekir. Bu yalnızca kod yazmakla ilgili değildir; entegrasyonlar, uzantılar, eklentiler veya tamamen yeni uygulamalar yoluyla temel ürünün üzerinde ek değer yaratmakla ilgilidir.
Ürünleri daha ileri geliştirmeyi destekleyen dokümantasyon örnekleri Vercel Approval Checklist ve Chrome’un Debug extensions kılavuzudur. Odağın neredeyse her zaman uygulamaya dönük olduğuna, içerik türünün ise büyük ölçüde önem taşımadığına dikkat edin. Entegrasyon veya uzantı dokümanlarının çoğu kılavuz, hatta makale biçimindedir.
Geliştirme veya entegrasyon ihtiyaçlarına odaklanan dokümantasyon, ürünün bugünkü yetenekleri ile potansiyeli arasında köprü kurar. Kullanıcıları ortak üreticilere dönüştürür ve bir ekosistemin gelişmesini sağlar. Bu dokümantasyon türü çoğu zaman uygulama topluluklarının temelini oluşturur.
Kullanıcının yapmak istediği
Kullanıcıların çoğu zaman mevcut ürünlerin üzerine bir şeyler inşa etmesi, onları genişletmesi veya entegre etmesi gerekir: entegrasyonlar, uzantılar, eklentiler veya tamamen yeni uygulamalar yoluyla. Odak neredeyse her zaman pratiktir.
Dokümanlarınızın bu ihtiyacı karşılamadığını gösteren işaretler
- Entegrasyon ve uzantı soruları yanıtsız kalıyor veya bir foruma yönlendiriliyor.
- Ürünün üzerine bir şeyler inşa etmek için kılavuz yok.
- Ürünün genişletme noktaları belgelenmemiş.
Gerçek dünyadan iki örnek
Yaygın içerik türleri
| DITA | Diátaxis | Good Docs Project |
|---|---|---|
| <task>, <codeblock>, <coderef> | Nasıl yapılır kılavuzu | Nasıl yapılır kılavuzu, API başvuru kaynağı |
Bir metrik
ekosistem büyümesi · Kullanıcılar tarafından oluşturulan entegrasyon veya uzantı sayısı.