Dokümantasyon şablonları

Oluşturulan her belge bir belge şablonunu temel alır. Uygulamada bu şablonlara Belge şablonları denir. Şablon, belgenin hangi bölümlerden oluşacağını ve bunların hangi sırayla yer alacağını belirler: başlık sayfası, içindekiler tablosu, bölümler ve alt bölümler, metin blokları, dokümantasyon alanları, model, RACI matrisi, öğe dokümantasyonu, grafikler ve etkinlik başına RACI ataması.

Her mimari düzeyin kendine ait şablonları vardır. Böylece kısa bir süreç özeti, ayrıntılı bir SOP ve denetim paketi aynı süreci farklı biçimlerde anlatabilir.

Şablonların bulunduğu yer

• Ayarlar → Process Architecture bölümünde her düzey bir kart olarak gösterilir. Düzenleyiciyi açmak için düzeyin Belge şablonları etiketini veya düzenleme simgesini seçin.
• Dokümantasyon sekmesinde, kenar çubuğundaki Belge şablonu seçicisi görüntülediğiniz belgeyi değiştirir. Başka bir şablon seçilene kadar düzeyin varsayılan şablonu kullanılır.
• Düzenleyiciler, dışa aktarma menüsünü açıp Şablonu düzenle… seçeneğini belirleyerek belgeden doğrudan şablonuna geçebilir.

Şablonlar Process Architecture bölümünde yapılandırılır. Sürecin dokümantasyonunu okuyabilen herkes, şablonun oluşturduğu belgeyi görür. Her dışa aktarma işleminde dokümantasyon sayfasında seçili olan şablon kullanılır.

Şablonları seçme ve yönetme

Düzenleyici tek bir iletişim kutusundan oluşur: üstte şablon seçici ve ekleme düğmesi, solda belge ağacı, sağda ise seçili düğümün ayarları bulunur. Alt kısımdaki düğmeler İptal ve Kaydet seçeneklerini sunar.

Düzenleyici, ilgili düzeyde en son düzenlediğiniz şablonla açılır. Dokümantasyon sayfasındaki Şablonu düzenle… seçeneği, mevcut belgenin kullandığı şablonu açar.

• Belge şablonu seçicisi, üst kısımda yer alır ve düzeyin şablonları arasında geçiş yapmanızı sağlar. Taslak olarak işaretlenen şablonlar görüntüleyicilere görünmez; Varsayılan etiketi, dokümantasyon sayfası açıldığında kullanılan şablonu belirtir.
• + simgesi, Yeni belge şablonu adlı bir şablon ekler ve onu seçer.
• Ad seçili şablonun adını değiştirir.
• Yayımlandı ayarı, görüntüleyicilerin dokümantasyon sayfasında şablonu seçip seçemeyeceğini belirler. Düzenleyiciler taslakları her zaman görebilir.
• Varsayılan olarak ayarla seçeneği, başka bir şablon seçilmediğinde dokümantasyon sayfasının kullanacağı şablonu belirler. Her düzeyin bir varsayılan şablonu vardır.
• Belge şablonunu sil seçeneği seçili şablonu kaldırır. Bir düzeyin tek varsayılan şablonunu silemezsiniz; önce başka bir şablonu varsayılan olarak ayarlayın.
• Belgelendirilmemiş öğeleri dahil edin seçeneği, henüz açıklaması olmayan model öğelerini belgenin öğeler bölümüne ekler. Belgede yalnızca tamamlanmış dokümantasyonun listelenmesini istiyorsanız bu seçeneği kapatın.

Şablon ekleme, şablon silme ve varsayılanı belirleme işlemleri hemen uygulanır. Ad, görünürlük, içeriği dahil etme anahtarı, başlık sayfası ve belge ağacı Kaydet seçeneğiyle kaydedilir.

Belgeyi oluşturma

Düzenleyicinin sol tarafında belge ağacı bulunur. Bir düğümü yeniden sıralamak için sürükleyin veya bir bölümün ya da alt bölümün içine taşımak için üzerine bırakın. İçerik eklemek veya kaldırmak için satır menüsünü ya da satıra sağ tıklayın.

Bölümler ve alt bölümler

• Altına bölüm ekle seçeneği, belgenin en üst düzeyine bir bölüm ekler.
• Alt bölüm ekle veya Altına alt bölüm ekle seçeneği, iç içe bir alt bölüm ya da aynı düzeyde yeni bir alt bölüm ekler.
• Bir bölüm veya alt bölüm seçerek Başlık alanını düzenleyin ve Otomatik numaralandır seçeneğini açıp kapatın. Numaralandırma ağaç yapısını izler: bölümler X, alt bölümleri X.Y, daha derindeki alt bölümler ise X.Y.Z biçiminde numaralandırılır. Panelde, düğümün hangi başlık düzeyinde görüntüleneceği belirtilir.
• Sil seçili düğümü ve alt öğelerini kaldırır.

İçerik düğümleri

Düğüm menüsünde şu seçenekler bulunur:

• Metin ekle / Altına metin ekle seçenekleri Markdown bloğu ekler. Markdown metni alanına başlıklar, listeler, bağlantılar veya notlar yazın. Burada yer tutucular da kullanabilirsiniz.
• Dokümantasyon alanı ekle… / Altına dokümantasyon alanı ekle… seçenekleri, düzey için yayımlanmış dokümantasyon alanlarından birini ekler. Sonradan yayımdan kaldırılan bir alan belgeden çıkarılır; böylece belgede düzeyin artık yayımlamadığı içerikler gösterilmez.
• Model ekle / Altına model ekle seçenekleri süreç diyagramını oluşturur. Diyagramın altına “Kullanılan filtre ve veri” özetini eklemek için Veriyi göster seçeneğini kullanın.
• RACI ekle / Altına RACI ekle seçenekleri RACI matrisini oluşturur.
• Öğeleri ekle / Altına öğe ekle seçenekleri tüm model öğelerinin dokümantasyonunu oluşturur.
• Grafik bölümü ekle seçeneği, grafik dokümantasyonunu belgenin seçili konumuna yerleştirir. Bu seçeneği belgenin en üst düzeyinde veya herhangi bir bölümün ya da alt bölümün içinde kullanabilirsiniz.
• Tek tek etkinlikler için RACI ekle seçeneği, öğeler bölümündeki her etkinliğe RACI atamasını ekler. En üst düzeyde kullanıldığında belgenin tamamına uygulanır.

Başlık sayfası ekle ve İçindekiler tablosu ekle seçenekleri yalnızca belgenin en üst düzeyinde, birer kez sunulur. İkisi de birer düğümdür: düzenlemek için düğümü seçin, başlık sayfası veya içindekiler tablosu istemiyorsanız silin.

Başlık sayfası

Aşağıdaki ayarları yapmak için başlık sayfası düğümünü seçin:

• Arka plan görseli için görsel yükleyin, Değiştirin veya kaldırma simgesini kullanın.
• Başlık varsayılan olarak süreç adını kullanır. Başlığın süreci takip etmesi gerekiyorsa yer tutucular kullanın.
• Sürüm, sınıflandırma veya hedef kitle bilgisi için alt başlık ekleyin.

Yer tutucular

Düzenlenebilir metinlerde, ProcessMind’in belgeyi oluştururken doldurduğu yer tutucuları kullanabilirsiniz:

{{processName}}, {{processCode}}, {{processClassification}}, {{processOwner}}, {{processShortDescription}}, {{processStatus}}, {{version}}, {{author}}, {{publishedDate}}, {{currentDate}}

Kopyalamak için yer tutucu etiketine tıklayın; düzenlediğiniz metne eklemek için etikete çift tıklayın. Bir süreç için değeri olmayan yer tutucu, boş metin olarak görüntülenir.

Şablonlar ve dışa aktarma

Şablon, belgenin kendisini belirler. PDF, Word, Markdown ve yazdırma işlemlerinde seçili şablon kullanılır; şablonda yer almayan içerik dışa aktarılan belgede de bulunmaz. Bir bölümü tek bir şablonda gizlemek için ilgili düğümü silin. Bir süreç düzeyi için birden fazla belge biçimi kullanmak istiyorsanız her biçim için bir şablon oluşturun ve dokümantasyon sayfası açıldığında kullanılacak şablonu varsayılan olarak ayarlayın.

İlgili konular

• Dokümantasyon düzenleyicisi
• Dokümantasyonu dışa aktarma
• Process Architecture
• Mimari düzeyleri