Yinelemeli dokümantasyon geliştirme mümkün mü ve etkili dokümantasyon sağlıyor mu?


11

Üniversite için hemen başlamayacağım, ancak oldukça uzun bir süredir düşündüğüm bir projem var. Üniversite proje geliştirmesinin sanayi gibi olmadığını anlıyorum (şu anda kendim stajyerim), bu yüzden şu anda işaret edeceğim durum muhtemelen gerçek yazılım geliştiricileri için biraz saçma görünecektir. ^^'

Projenin kendisi, çalışmalarımızın çoğunu belgelememizi gerektiriyor. Bu nedenle, bazı işaretlere dahil olan kod teslim etmenin yanı sıra, aşağıdakileri içeren belgeleri de teslim etmeliyiz:

  • İhtiyaç Analizi Belgesi
  • Bir Proje Planı
  • Kullanım Örnekleri, Nesne ve Dinamik Modeller ve Kabul Testlerinin planlı bir listesi
  • Test sürecinin dokümantasyonu ve testlerin ne kadar başarılı olduğu
  • Zaman kullanımı gibi diğer bazı tartışmalar ve analizler.

Bu teslimatlar aşağıdaki şekilde teslim edilecektir:

  • Önce RAD
  • Ardından Proje Planı, Kullanım Örnekleri, Modeller ve Testler (yaklaşık 3 hafta sonra)
  • Son olarak, gerçek programın belgelenmesi, test süreci vb. + Gerçek programlamanın kendisi (yaklaşık 5 hafta sonra)

Yani, anladığım kadarıyla, bu gerçekten projeye Şelale tarzı bir yaklaşıma yönelik. Tek sorun (bence) bunun bir Üniversite projesi olması ve öğrencilerin proje haftasında dönem sonunda proje geliştirmeye çalışırken olduğu gibi zaten yeterince baskıları var. Gerçekten, her ne kadar uğraşmak zorunda olduğum diğer birçok değerlendirme ile panik olacağım dönem sonunda her şeyi kodlamak / geliştirmek / test etmek istemiyorum.

En azından kodlamaya / prototiplemeye erken başlayabileceğimiz, son dakikada her şeyi yapmaya odaklanmayan ve çok fazla baskıya sahip olamayacağımız sürekli bir geliştirme döngüsüne sahip olabileceğimiz anlamına gelen bir çeşit yinelemeli gelişim döngüsü denemek ve yapmak istiyorum. bu projeyi bitirmek için dönem sonu. Ve şimdi asıl sorularım geliyor:

  • Bir şekilde tüm bu belgeleri hızlı, yinelemeli / prototip geliştirme döngüsü ile teslim etmek zorunda kalabilir miyim?
  • Yinelemeli bir şekilde dokümantasyon oluşturmak için stratejiler var mı?
  • Bunu sormaktan ve üniversitede yapılabilmesini beklemek tamamen mantıksız mı?

Ayrıca, bu sorunun son derece yerel olduğunu anlıyorum, bu yüzden yukarıda sanayi ile ilgili sorduğum aynı soruları ve çevik süreçlerin karşılaştığı bu tür sorunların her takım için farklı olup olmadığını sormak istiyorum. veya şirket.

Her neyse, bunun ne kadar uzun olduğu için özür dilerim. Cevap vermek için zaman ayırabilseydin, çok minnettar olurum! Teşekkür ederim!


2
Bu yanıt vermiyor, bu yüzden cevap olarak koymuyorum. Ama yapma . Eğitmeninizin istediği şey, düşüncelerinizi organize etmeniz ve henüz yazmadığınız bir sistemi planlama ve tartışma yeteneğinizi geliştirmenizdir. Bunlar sahip olmak için çok iyi becerilerdir ve programlama işine birkaç yıl girdikten sonra oldukça pazarlanabilir.
Ross Patterson

Tamam. Yine de, talepleri karşılamak ve müşteri çözümlerini kavramsallaştırmak için olası bir ürünün prototipini içeren bazı planlama yöntemleri gibi görünüyor olabilirim; bu, planlama ve dokümantasyon aşamasını geliştirmeye veya desteklemeye yardımcı olmak için iyi bir yol mu? Yoksa bu sadece mantıksız bir arzu mu?
blahman

2
Elbette, prototipleme geçerlidir. Aslında, büyük bir şirkette, prototipi son sistemin temeli olarak kullanma niyetiniz olmasa bile, büyük harfli Ar-Ge'yi (teknik bir şey değil, bir muhasebe meselesi) haklı çıkarmak için bir prototip oluştururken kendinizi bulabilirsiniz. Aslında, en iyi prototipler rehberlik sağlayan ve daha sonra atılanlardır. Birkaç yıl sonra yeniden yazılması gereken her "ürün haline getirilmiş" prototip için bir nikel olsaydım, çok fazla nikel olurdu.
Ross Patterson

Yanıtlar:


5

Ana endişe (işimle benzer bir sorunum var) eğer "Süreç" belirli zamanlarda belirli eserler teslim etmenizi talep ederse ve hiç kimsenin her şeye kadir "Süreç" e meydan okumasına izin verilmezse, o zaman denerseniz, kaybedecek! Bu sadece daha iyi bir yol olması basit bir mesele değil.

Yapmanız gereken şey süreç içinde çalışmaktır, ancak istediğiniz şekilde çalışmanın bir yolunu bulmaktır. Örneğin, işleminiz gönderildikten sonra belge değişikliğine izin veriyor mu? Değilse, yinelemeli bir gelişme mümkün değildir. Eğer öyleyse, o zaman teslimat maliyetini düşünmelisiniz (Zamanınız, güvenilirliğiniz vb.) Ve bu maliyeti yönetmelisiniz. Örneğin, bir dosya kopyası ve başka bir şey değilse, o zaman gidin. Eğer benim gibi bir akran incelemesi, revizyon sürümü, düzinelerce insanı etkiliyorsa ve binlerce dolara mal oluyorsa, dikkatlice düşünün ve yeni belgenin gerçekten değer kattığından emin olun.

Ortak bir çalışma yöntemi, başlangıçta "Süreç" in ihtiyaçlarını karşılayan asgari bir belgedir, daha sonra sadece gerçeği yansıtmakla kalmayan, aynı zamanda gerekli ayrıntıları içeren nihai bir "yerleşik" güncellemedir. kodun kendisi için konuştuğu yer.


Girdiniz için teşekkürler! Söyledikleriniz ve bunu kendi projelerime nasıl uygulayabileceğim hakkında biraz daha düşündüm. Belgelerimizin çoğunda, bir son teslim tarihine kadar göndermemiz ve bundan sonra anlamlı bir değişiklik yapmamıza rağmen, danışmamız gereken bir müşterimiz olması gerekiyor. Yine de müşteri danışmanlığı ile yinelemeli gelişim hala mümkün mü? Demek istediğim, bu döngüler halinde gelişmenin noktası, değil mi?
blahman
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.