Soru Geliştiricilerin bir wiki kullanması [kapalı]


Farklı takımların kendi modüllerinde bir çakışma derecesiyle çalıştığı karmaşık bir uygulama üzerinde çalışıyorum. Bir süre önce kısmen sormamıza bağlı bir Mediawiki örneğini aldık. İnsanları aslında kullanmasına izin vermekle uğraşmak zor bir işim var.

Bilgi paylaşımında çok fayda görüyorum. En azından tekerleği yeniden icat ettiğimiz zamanları azaltabilir.

Viki çok yapılandırılmış değil, ama ihtiyacınız olanı arayabildiğiniz sürece bir sorun olduğundan emin değilim.

Herhangi bir ipucu?


17
2017-08-19 07:57


Menşei


stackoverflow.com/questions/3167909/... - zengr


Cevaplar:


Bahsettiğim gibi önceBir Wiki çok örgütlenmemiş.

Bununla birlikte, geliştiricilerinizin tek argümanıysa, basit bir indeks sayfası oluşturmak ve güncel tutmak için biraz çaba harcayın (ya kendiniz yapın ya da insanlardan katkılarını endekse bağlamalarını isteyin). Böylece Wiki, tüm çalışmalarınız için çok güzel ve oldukça kapsamlı bir dokümantasyon koleksiyonuna dönüşebilir.


8
2017-08-19 08:05





Bazı ipuçları:

Birisi e-posta yoluyla gerçekten bir wiki içinde olması gereken bilgiyi gönderir, bu konuyla ilgili bir sayfa hazırlar ve e-postaya ne eklediklerini ekler. Ardından "Bu bilgi için teşekkürler, buradaki vikin içine koydum, böylece gelecekte bulmak daha kolay."

Aynı şekilde, bilginiz varsa, wiki içinde olması gereken paylaşmanız gerekir, oraya koyun ve sadece e-posta insanlara bir bağlantı ile bir e-posta gönderin.

İnsanlara bilgi talebinde bulunduğunuzda, bu tür belgelerin wiki'ye eklenmesi varsayılan veya standart olarak kabul edilmelidir: "Ben wiki'de aradım ama bulamadım. Bu bilgiyi oraya koydunuz mu?"

Eğer "wiki şampiyonu" iseniz, başkalarının nasıl kullanılacağını bildiğinden emin olun, örn. "Seninle yeni bir sayfa nasıl oluşturabilirim?"

İşinizle ilgili olduğundan emin olmak için kenar çubuğunu düzenleyin.

Daha kolay gezinmek için ilgili sayfalarda "nav kutusu" stil şablonlarını kullanın.

Ön sayfada {{Special: NewPages / 5}} gibi bir şey veya son değişiklikleri yapın, böylece kullanıcılar etkinliği görebilir.

Son birkaç günde bir veya birkaç haftada bir değişiklik yapın ve bir kimsenin prodüksiyon yapmadan bilgi eklediğini fark ederseniz, onlara bir e-posta gönderin veya bir e-posta gönderin ya da onlara küçük bir iltifat verin.


26
2018-02-23 14:01



Çok fazla şey yapıyorum zaten. Bizim QA ve uygulama departmanları wikiyi kullanmaya başlıyor, bu yüzden umut var. Üzerinde çalıştıkları modülleri belgeleyen daha geliştiriciler görmek isterim. Bunu sadece kendi çıkarlarım için yapmaya devam edeceğim. - steevc
{{Special: NewPages}} için öğe sayısını sınırlamak için doğru sözdizimi {{Special: NewPages / 5}} - Abtin Forouzandeh


Şimdi bir süre için bir wiki kullanıyoruz, ama insanlar gemiye binmek için biraz zaman alıyor. Bir süredir sadece bir yazı yazımı olacağınızı düşünebilirsiniz, ancak bununla birlikte, diğer insanlar sonunda gemiye geleceklerdir.

Birisi projeyle ilgili bilgileri içeren bir e-posta gönderirse, o zaman bunu wiki yönünde yönlendirin - ve bunu yapmaya devam edin - ipuçlarını almalıdırlar.

Bir SharePoint portalımız var ve wiki'yi oradan kullanıyoruz - kendi markamızla özelleştirdik, böylece "parçalara benziyor" - gerçekten bunun bunun alınmasını geliştirdiğini hissediyorum.

Herkesin wiki'nin e-postadan bile daha gayri resmi olduğunu bildiğinden emin olun .... çünkü insanların, wiki'ye ekledikleri her şeyi aşırı analiz edeceğini düşündükleri bir "korku faktörü" olacaktır.


6
2017-08-19 08:14



Geçmişte BT dokümanlarımız için bir SharePoint wiki ve çeşitli sorunlara yönelik çözümler kullandık. İlk başta harikaydı, ama sonra bizim SharePoint sunucumuz çöktü ve biz düzeltmek için sahip olduğumuz belgelere erişemedik. Artık farklı bir sunucuda özel bir MediaWiki destekli wiki var, daha iyi çıktı. Veritabanı, SharePoint’den de biraz daha erişilebilir. - Auguste


Şimdiye kadar cevapların çoğunun üzerinde durduğunu düşünüyorum - kendinize daha çok taktığınızda, yararlı bilgilerin vücudu ne kadar büyüyecek, o kadar yavaş ama emin bir şekilde insanlar bunu doğal olarak kullanmaya başlayacaklar.

Kullanabileceğiniz diğer bir yaklaşım şudur: Birisi başka bir takım üyesine proje hakkında bir soru sorduğunda, soruyu normal olarak yanıtlamalı, aynı zamanda Wiki'nin bir bölümüne de cevabı eklemelidir. Bu birkaç dakika fazla sürebilir, ancak bir dahaki sefere aynı soruyu sorar (ki kaçınılmaz olarak). Bu, Wiki'de işaret ederek zaman kazanabilirsiniz. Bu, sırayla, insanların Wiki'yi ilk bilgi kaynağı olarak kullanmaya başlaması ve genel olarak yardım almasına yardımcı olmalıdır.


5
2017-08-19 08:21





Geliştiricilerin, kullanmaya teşvik etmedikleri bir şey yapmaya zorlayamazsınız; maalesef belgeler gibi wikis (aslında Hangi belgeler), geliştiriciler için nadiren "cool" bir değere sahiptir. Üstelik, onlar zaten çok çalışkan bir şeydir - onları bir wiki ile gerçekten rahatsız edebilir misiniz?

Bu söylendiğinde, wiki'ye itilen insanlar (ör. Siz) öncelikle onu güncellemekten sorumlu olmalı, ve eğer bu konuda ciddi iseniz, gerçekten sizin için çok fazla iş çıkarmış olursunuz.

Ayrıca ff'yi de deneyebilirsiniz:

  • Çok yapılandırılmış değil - bir çok insan kötü yapılandırılmış (zorla arama / göz atma) wiki'lerden uzaklaşıyor. Yani belki önce bunu düzeltebilirsin
  • Belki de, geliştiricilerin / proje yöneticilerinin kendileri için sorun olan şeylerle doldurmasını isteyebilirsiniz: özel projeniz için kod kuralları ve API tasarımı gibi şeyler
  • Örnek olarak kurşun: dini belge sizin sistemin bir parçası. Bir emsalin ayarlanması, başkalarını aynı şeyi yapmaya teşvik edebilir

4
2017-08-19 08:08





Vikiyi geliştiricilere kullanma fikrini satmak. Bazı faydalar belirlediniz, bunları geliştiricilerle paylaştınız. Onlar bunun dışında bir değer elde edeceklerini görebiliyorlarsa, kullanmaya başlayacaklardır.

Örnek avantajlar Wiki nedir

  • Resmi yazım ve düzenleme için size daha fazla zaman kazandıran hızlı fikirleri veya daha uzun olanları yazmak için iyi.
  • Dokümanı e-postayla göndermeden anında işbirliği yaparak grubu senkronize edin.
  • Web bağlantısı olan her yerden erişilebilir (web tarayıcı metin formlarında yazmayı önemsemiyorsanız).
  • Arşiviniz, çünkü her sayfa revizyonu korunur.
  • Heyecan verici, acil ve güçlendirici - herkesin bir sözü vardır.

3
2017-08-19 08:00





Bazı satışlar yaptım ve hatta bazı eğitim seansları yaptım. Bazı insanlar WYSIWYG düzenleme ve Word veya Outlook biçimlendirilmiş metin yapıştırma yeteneği nedeniyle kapatıldı düşünüyorum. Buralarda çalışmak için bazı araçlar olduğunu biliyorum, ama hala engeller.

Wiki'nin belirli alanları günlüğe kaydetmek için kullanıldığı bazı alanlar var, ancak bunları güncelleyen kullanıcılar bununla herhangi bir şey yapmıyor.

Uygun bir beyin uzantısı olarak hareket ettiğinden bağımsız olarak alanımı belgelemek için wiki'yi kullanacağım. Yeni bir geliştirme başlatırken, ilerledikçe genişletebileceğim fikirler için bir not defteri olarak kullanıyorum.

Zorunlu olmasa bile yönetimin bazı vokal destek vermesi yardımcı olacaktır.


2
2017-08-19 08:11



Artık doğru değil: WYSIWYG wiki var. Örneğin. Wikiwig - Berry Tsakala
MediaWiki için oldukça güzel bir CKEdit WYSIWYG eklentisi kullanıyorum: mediawiki.org/wiki/Extension:FCKeditor_%28Official%29 - mskfisher


İnsanları aslında kullanmasına izin vermekle uğraşmak zor bir işim var.

İnsanları bir vikiye katkıda bulunmanın en kolay yollarından biri, onlara wiki-uygun bir şekilde içerik sağlamalarını sağlamaktır, yani her zamanki iletişim kanallarını (haber grupları, posta listeleri, forumlar, sorun izleyicileri) kullanarak yayınladıkları şey , sohbet), temel olarak wiki'ye dahil edilmek için uygundur.

Öyleyse diğerleri (kullanıcılar / gönüllüler) sadece bu tür içerikleri alıp wiki'ye yerleştirebilir.

Bu, gerçekte olduğundan daha karmaşık geliyor, çoğunlukla soruları ve cevapları genelleştirmekten ibaret, bu yüzden mutlaka bir konuşmanın parçası değiller, ama bağımsız bir şekilde anlaşılabilir, anlamlı ve yararlı olabilirler.

Örneğin, aşağıdaki gibi bir soru:

uzak bir depo klonlamak için git nasıl alabilirim ???

Bunun gibi cevaplanabilir:

Merhaba,   Sadece git clone git: // ... kullanın

Ancak sorular daha az kişisel bir tarzda cevaplanabilir:

Git deposunu klonlamak için clone parametresini git'e getirmek isteyeceksiniz:   git clone git: // ....

Söylemeye çalıştığım şey, bir projedeki çoğu tartışmanın, en sonunda belgelere dönüşmek için kolayca kullanılabileceği ve kullanılması gerektiği. Bu türden bir zihniyetle, belgeleriniz gerçekten hızlı bir şekilde büyüyebilir. İnsanlara, yararlı bilgilerin wiki dahil edilmesine uygun bir tarzda ideal olarak sağlanması gerektiğini akılda tutmanız gerekir.

Açık kaynak projelerinin bu yaklaşımı bir ölçüde kullanmaya başladığı bazı vakalara şahit oldum ve bazı insanlar (büyük ölçüde yeni kullanıcılar) cevapların çok kişisel olmadığından şikayet ettikleri halde, belgelerin gövdesi sürekli olarak arttı, çünkü diğer insanlar sadece bu tür tartışmaları izlediler ve wiki'ye bu tür yanıtları kopyalamaya / yapıştırmaya başladı.

Temel olarak, insanların bir vikiye katkıda bulunabilmeleri için en kolay yollardan biri budur, onları kendileri kullanmalarını gerektirmeksizin, kendilerinden beklenen tek şey, düşünmede bir değişimdir.


1
2018-06-07 17:27





Geliştiricilerin hala 'gerçek' belgeleri (s.a. Word belgeleri) tutmaya ihtiyaçları varsa, bunu bir Wiki üzerinde anlamlı bir şekilde kopyalamanın bir yolunu görmüyorum.

  • İnsanların iki kere yazması mantıklı değil
  • Yinelenen tüm veriler yakında senkronize edilmeye eğilimlidir.

Mevcut müşterimin yaptığı şey, tüm bunları Wiki'ye taşımak. Bu yüzden sadece bir kez belgeleyeceğim ve yapıyorum üzerinde Wiki.

Tamamdır. Wiki ile çalışmak, Word'den daha sıkıcıdır, ama en azından dokümanlar çevrimiçi ve diğerleri de onunla karışabilir.

Başka bir çalışma çözümü (imho), dökümanları kaynağın yanına aldatmanın üzerine koymak olacaktır. Ancak, birleştirme sisteminin zengin metin vb. İle de başa çıkabilmesi gerekiyor. Bilmiyorum, bunun için herhangi bir çözüm varsa (HTML veya LaTex kullanmanın dışında, aslında kötü seçim olmaz).


1
2017-07-12 17:10