İlk önce serbest bırakılsın mı yoksa ilk önce belgenin mi?


23

Birkaç yıldır bir proje üzerinde çalışıyorum ve iyi bir kullanıcı tabanı toplamaya başladım. Bazı temel belgelere sahip bir proje sayfası oluşturdum, ancak bu noktada bir SSS'den başka bir şey değil. Hem yeni hem de ileri düzey kullanıcılar için daha bilgilendirici olacak ve onu bir sonraki sürüm için yapılacaklar listemde sırada olacak şekilde geliştirmem gerektiğini biliyorum.

Bununla birlikte, bir sonraki sürüm, kullanıcı tabanının edinme konusunda endişeli olduğu özelliklere sahiptir. Şu anda bırakmaya hazırım, paketlenmiş ve gitmeye hazır. Sadece uygun dağıtım servislerine dağıtmam gerekiyor.

Diyeceğim şey şu ki. Özellikler kullanıcılarım için önemlidir, ancak belgeler benim için önemlidir. Belgeleri yeniden yazana kadar serbest bırakmak için beklemeli miyim? Mevcut kullanıcı tabanım yeni özelliklerin nasıl kullanılacağını anlamak için yeterince anlayışlı, bu yüzden endişelendiğim şey bu değil. Bu proje üzerinde çalışmak için boş zamanım olduğu için, dokümanları bitirmek birkaç hafta alabilir, ancak onları daha fazla bekletirsem topluluğum tükürür.

Müşteri bu senaryoda doğru mu? Mevcut kullanıcılar için fantastik ve anlaşılır bir özellik, yeni kullanıcılar için sağlam belgelere göre öncelik kazanmalı mı?


Güncelleme: Vay, çok büyük, yüksek kaliteli tepkiler! Hem projeyi hem de kullanıcılarını nasıl etkileşime sokmam ve desteklemem gerektiğini daha iyi anlamama yardımcı oldunuz. Bir milyon teşekkürler!


14
Evet, müşteri haklı. Yayını açın, ardından iki haftayı belgelerin yerini almak için harcayın. Kullanıcı tabanının dokümantasyon eksikliğinden olumsuz etkilenmeyeceğini zaten söylediniz ve bu sadece iki hafta daha sürecek. Bu gerçek bir konser olsaydı, müşteri veya kuruluşunuz sizi gerçek bir tükürükte kızartırdı, çünkü piyasaya sürülmeden iki hafta sonra pazar payını kazanmak için iki hafta daha az kaldı.
Robert Harvey,

3
Projeye bağlı olarak yeni sürümü "beta" veya "önizleme" olarak ayrı bir şubede yayınlayabilirsiniz.
CodesInChaos

2
Ne tür belgeler - son kullanıcıların belgeleri veya kaynak kodu belgeleri? Yoksa bunlar arasında hiçbir ayrımın olmadığı bir projeniz mi?
Doktor Brown,

5
Burada herhangi bir çatışma olması görünmüyor: ambalajlanmış ve daha sonra gitmek neden serbest olamaz hazır eğer ve iki hafta içinde dokümanlar yalnızca güncelleştirme için, bir sonraki belgelerde üzerinde çalışmaya? Serbest bırakmanın, dokümanlar üzerinde çalışmanızı önleyen çok sayıda çalışma (raporlanan hatalar vb.) Oluşturacağından endişe duyuyor musunuz? Her ikisini de yapamamanızın nedeni cevaplarla dikkate alınmalıdır.
Steve Jessop,

@DocBrown Bu durumda, kullanıcı dokümanıdır. Kaynak kodu dokümantasyonu sadece benim için yararlı olacaktır.
siberbit

Yanıtlar:


45

Basit: Bir beta sürümünü yayınlayın! Sonra belgeler tamamlandığında, yeni sürümün son sürümünü yapın.

Yeni şeyleri denemek isteyen kullanıcılarınız varsa, bundan kesinlikle yararlanın. Hata raporları alırsınız, muhtemelen zor noktalar hakkında topluluk soruları alırsınız, böylece belgelere nerede konsantre olacağınızı vb. Bilirsiniz. Ayrıca, kullanıcı geri bildirimlerine dayanarak dokümantasyonu etkileyebilecek bazı şeyleri ince ayar yapmak isteyebilirsiniz.

Temel olarak, herkes kazanır.


Erken yayın yapmamanın bir nedeni, kullanıcılarınızın bir "beta sürümü" nü kabul etmeyeceğini düşünüyorsanız, o zaman bunu iki kez düşünmelisiniz, ama yazdıklarınızı takip edersek, onun için mutlu olacak gibi sesler çıkarmalısınız.

Başka bir neden, kullandığınız yayın kanallarını kullanarak beta sürümü yayınlama konusunda teknik zorluklar olması durumunda olacaktır. Öyleyse, ayrı beta ve son sürümler yayınlamaya değecek kadar güç olabilir. Yazılımınızın tamamlandığını düşünüyorsanız, o zaman bu durumda erkenden piyasaya sürülmeli, bittiğinde dokümanları güncelleyiniz. Aksi halde, belgelerin ertelenmesi riski vardır ve ardından tüm sürüm ertelenir veya nihai belgelendirme olmadan serbest bırakılmaya başlayabilirsiniz, bu yüzden şimdi yapın.


1
Bunu geçmişte küçük aletler için yaptım, birçok kez ... kod yapıldı, hepsi işe yarıyor, ama hafta sonunun sonu ve belgeleri şimdi bitirmek için canımı sıkmıyor. Yeni sürümü kötü bir şekilde istiyorsanız, işte o zaman burada, aksi halde gelecek hafta sonu için beklemeniz gerekecek.
Pimgd

Buraya sormadan önce aslında beta sürüm almayı düşündüm! Bu fikrin sorunu, kullandığım kanalların beni yayınlamak için tamamen ayrı bir uygulama yazmaya zorluyor. Ayrı bir beta için çalışmaya başladım, ancak bunun lojistiği zor ve projenin bu aşamasında buna değmedi.
cyberbit

Bunun yerine, özelliği ile yapmayı seçtiğim normal sürümde bir tercih beta yapmak. Bu, istikrarlı bir deneyim isteyen insanların bunu sürdürmesini ve yeni özelliği isteyenler zaman zaman kırılabileceği bilgisi ile kullanabilmesini sağlar. Daha sonra, gelecekteki bir sürümde, bu özelliği katılımdan entegre olana taşıyabilir, beta tanımını kaldırabilir ve her şey yolundadır.
cyberbit

3
Apache, işlevsel olarak tamamlanmış bir projeyi işaretlemek için "Sürüm Adaylarını" kullanır, ancak yalnızca tüm kaynaklara sahip olduğunu doğrulayan ve tüm kaynakların kullanıma hazır olduğunu doğrular. Beta aşamasının ötesindeymiş gibi görünüyorsunuz (işlevsellik olgun ancak hala tamamlanmamış).
Berin Loritsch

@BerinLoritsch Daha önce kullanıldığını gördüm. Bu etiket aslında bu durumda iyi uyuyor. Sanırım normal bir sürümde bir katılım özelliği koymak (benim durumumda) sürüm adayı gibi bir şey. Kararlı, çalışıyor, ancak henüz ışığı görmedi.
cyberbit

15

Seni doğru amacımız, sizin bu projeyi yapıyoruz serbest zaman ve için hiç para . Bu durumda, lütfen, sizi daha iyi hissettiren şeyleri yapın (kullanıcılar bekler, zamanınızı belgeler). "Kullanıcılarınızdan" gelen baskıyı hissetmemelisiniz. Bu konuda birçok kişi internette yazdı (Büyük FLOSS yazarları ve baskıyı hisseden katkıda bulunanlar).

Ancak, ödeme alıyorsanız veya bazı avantajlar alıyorsanız, lütfen kullanıcılarınızın istediğini yapın. Bu , müşterileriniz veya kullanıcılarınız için en iyi olanı yapmak anlamına gelir , bu durumda, sadece yayınlayın ve zamanında belgelendirin. Yollarını bulabileceklerini söyledin, bu yüzden büyük bir sorun olmamalı.


Doğru anladın! Bu ödenmemiş bir konser. Ama bahsettiğim en güçlü kullanıcılardan biri olduğum için biraz fayda sağladım. : P Söylediklerin yine de anlamlı ve cevabını takdir ediyorum!
cyberbit

4

Genel olarak iki tür belge vardır: kodunuzu belgeleyen teknik (sınıflar, birimler, vb.) Ve kod ve kullanıcı belgelerinde yeni özelliklerin nasıl işleyebileceği ve uygulanabileceği. IMO, teknik dokümantasyon , özellikle yazılım geliştirme tam zamanlı işiniz değilse bir zorunluluktur . Hayat taahhüdü nedeniyle büyük boşluklar yazma koduna sahip olabileceğim için çok fazla zaman harcıyorum.

Kullanıcı dokümantasyonunun olması güzel ancak gerekli olmadığına inanıyorum. Elbette, uygulamanın karmaşıklığına, kullanıcı tabanının tartışılan konu alanındaki bilgisayarların ve sistemlerin kullanımına olan aşinalıklarına bağlıdır - sizin durumunuzda, müşterilerinizin yeni özelliklerin nasıl çalıştığını anlayabilmesi gibi görünüyor. İyi bir kullanıcı deneyimi ve iyi bir kullanıcı arayüzü için en az kullanıcı dokümantasyonunun gerekli olduğunu tartışan bir düşünce okulu vardır.

Ayrıca, zamanınız sınırlıysa ve önerdiğiniz gibi belgeler geliştirmek için gerçekten baskı hissediyorsanız, yalnızca yeni özellikleri tanıtan birkaç kısa video yapabilirsiniz. Bu size gerçek belgeleri yazmak için biraz zaman kazandırır ve daha az önemli bilgileri doldurabilirsiniz.

Bazı pazarlama ipuçları, kullanıcı beklentilerini dengelemenize ve markanızı artırmanıza yardımcı olabilir. Gerçekten de uygulamanın türüne ve şu ana kadar oluşturduğunuz iş akışına bağlıdır, ancak yeni sürümünüz için bir hoş geldiniz ekranı olabilir ve uygulamanın içinde ya bağlantılar sağlayarak ya da uygulamanın içindeki videoları oynatarak videoları gösterebilirsiniz.


3

Sadece bu belirli örnek için değil, genel iş akışı için de bir şeyler eklemek için:

Dokümantasyon sizin olabilir definition of done, ancak dokümantasyon asgari düzeyde uygulanabilir bir ürünün (MVP) ötesinde bir zamandır .

Sadece müşteri her zaman haklı değildir. Eğer ticari bir ürün ise, piyasaya sürmek çok iş değeri olabilir ve mutlak bir önceliktir.

Mal sahibi, iş değerini (hangisini umursuyorsunuz) tanımlar, bu nedenle müşterileriniz için bir ürün olarak daha değerli olan nedir?

Ayrıca dokümantasyon olmadan salıverme riskleri var mı?

Örneğin rekabet ; Yarışma bu süper özelliği sizden önce yayınlarsa, bazı kullanıcıları kaybedebilirsiniz.

Bu soruları kendinize veya ürün sahibinize sorun, cevabınız açık olacaktır.


2

Yeni özellikler eski kullanıcıları mutlu eder. İyi dokümantasyon yeni kullanıcıları davet eder. Hangisine konsantre olmanız gerektiğine, hangisine daha fazla ihtiyacınız olduğuna bağlı. Kullanıcı tabanının sağlıklı olduğunu, böylece yeni özelliklerin beklediğini söylediniz. Eski bir kullanıcı olarak konuşurken, iyi belgeleri de severim. Açık kaynak ile ilgili güzel bir şey: eski kullanıcılar kendi özelliklerini ekler.


2
İyi dokümantasyon sadece yeni kullanıcıları gerçekten var olan bir şeyi belgelerse davet eder.
Robert Harvey,

@robertharvey Geçerli bir kullanıcı tabanı belirtildi. Bu nedenle, yayınlanmamış betaları bir şey veya başka bir şekilde kullandıklarını farz ediyorum.
candied_orange

Sesini belgelemesine rağmen kararlı olduğu düşünülen mevcut bir sürüm var.
jpmc26

2

Sorunuzda netleştin ve muhtemelen bu seçeneklerin sonuçlarını kullanıcılarınıza değil. Kullanıcı desteğine ne kadar zaman harcıyorsunuz? Ek belgeler destek için harcadığınız zamanı azaltır mı yoksa satışları artırır mı? Belgelendirme yapmanın avantajı nedir?

Kullanıcılarınız dokümantasyon üzerinde yeni özellikler istiyor, ancak destek sağlama, hataları düzeltme, sürüm düzeltme ekleri, vb. Sağlama durumunuzda bir düşüş olabileceğini biliyorlar mı?

Yapmam gereken tek şey sorumu size bir e-posta göndermek olduğunda talimatları okumayı başaramazsam neden yeni özellikler hakkında dokümantasyon isteyeyim?


-1

Paket serbest bırakılmaya hazırsa, müşteriye / müşteriye bırakın ve belgeler üzerinde çalışmaya başlayın. Dağıtılan özellikleri anlamalarına yardımcı olacak belgeleri paylaşacağınız zaman müşteriyle iletişim kurmak iyidir.

Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.