Her Yerde Dil Nasıl Belgelenir?

Şirketimiz birçok manuel iş sürecini (ve ilgili kurumsal bilgiyi) yeni kurumsal yazılımlara dönüştürme sürecindedir. Proje gerçekten iyi gidiyor, ancak ilerledikçe, hem iş hem de kalkınma taraflarında terim ve tanımlarla ilgili çok fazla karışıklık olduğu açık.

Evan'ın bir süre boyunca her yerde bulunan bir dil oluşturma argümanlarının farkındaydım, ama bu onları ilk kez resmi olarak belgelemem gerekti. Etrafa baktığımda ve UL şartlarımızı nerede / nasıl belgeleyeceğimizi düşünmeye çalışırken, biraz kayboldum.

Diğer şirketler her yerde bulunan dili nasıl belgeliyor? Bu sadece wiki tarzı bir sözlük mü? Bu amaca yönelik bazı araçlar var mı?

"Her yerde kullanılabilen dil dokümantasyonu" nı bir yazılım özelleştirme projesi olarak değerlendirebilirsiniz: dokümantasyon yönetimi için bazı yazılımlar almanız ve özel ihtiyaçlarınıza uyarlamanız gerekir. Yazılım projelerinde normalde kullanıcı ihtiyaçlarını toplamaya başlarsınız, daha sonra bilgi mimarisi ve tasarım çözümü geliştirirsiniz ve ardından uygulamaya devam edersiniz. Aşağıda bu sürecin örneği verilmiştir.

Kullanıcının buna ihtiyacı nedir? Bazı organizasyonlarda, farklı alan adlarından farklı işlevleri olan insanlar, sorunlarını ve çözümlerini tanımlamak için ortak dil lehçesi kullanmak isterler. Bu lehçe sadece kelime dağarcığı (konuşma sözcükleri ve rakamları) ile tanımlanacaktır, çünkü telaffuz muhtemelen burada önemli değildir ve dilbilgisi dilin edebiyat biçimine dayandırılacaktır. Lehçeyi belgelemek için, bir kelime dağarcığını (terimler sözlüğü) yönetmek için en uygun olacak bir belge yapısı tasarlamanız gerekir.

İnsanlar bu belgeyi, kelimenin veya kısaltmanın anlamını öğrenmek, eşanlamlı veya tanımıyla doğru sözcüğü bulmak veya etki alanını oluşturan tüm kelimeleri öğrenmek için kullanmak isteyebilirler.

Bu kullanıcı ihtiyaçları için wiki gerçekten iyi bir seçimdir. Nasıl uyuyor? Confluence veya MediaWiki gibi iyi bir wiki sisteminde şunlar mümkündür:

• Her terim için bir makale oluşturun.
• Toplama için kullanılabilecek bazı ortak bölümler içerecek şekilde bazı şablonlardaki makalelerin ortak yapısını tanımlayın.
• Diğer wiki makalelerindeki terim tanımlarına kolayca bağlantılar ekleyin.
• Terim tanımlarıyla birleştirilmiş tablolar oluşturun ve bunları diğer belgelere ekleyin.

Şu anda Confluence'ı bilgi mimarisini belgelemek için kullanıyorum ve her yerde bulunan dil tanımları bunun bir parçası. Bu dokümantasyonun en üst seviyesi alan adlarıdır. Her uygulamada, örneğin güvenlik, ödemeler vb. Gibi birden fazla alan vardır. Bu alan adları, kullanıcının sistemle çok sayıda dil ile tanımlanabilen bir dizi etkileşimi ile tanımlanır, bu nedenle bu etkileşimlerin tanımlarını ayrı alt sayfalara ve tanımlara koyarım Bu etkileşimler tarafından etkileşim sayfalarının alt sayfalarında sunulan terimlerin yüzdesi. Birleştirilmiş tabloları üst sayfalara koydum, örneğin hangi senaryoların alan adını içerdiğini ve hangi terimlerin tanımlandığını görmek mümkün.

Bu dokümantasyon yapısı tamamlandığında ve daha ayrıntılı sistem spesifikasyonlarına gittiğimde, senaryoların IA ve UL tanımlarına başvurabilirim, örn. Z (UL bağlantısı) ".