Holarch

Gereksinimler

Belge oluşturma

Belgelere canlı izlenebilirlik, doğrulama ve arayüz matrisleri ile test raporları ekleyin, bunları dört biçimde dışa aktarın, bir temel çizgiden oluşturun ve işaretleyin: her sayfada ve dışa aktarımda bir şirket bildirimi, DoD dağıtım beyanı, ihracat denetimi bildirimi, telif hakkı veya sözleşme numarası.

Nasıl kullanılır →

Bu sayfada
  1. Genel bakış
  2. Kavramlar
    1. Matrisler
    2. Kopya değil, canlı
  3. Nasıl kullanılır
    1. Belgeye matris ekleme
    2. Matrisi dışa aktarma
    3. Temel çizgiden matrisler
    4. Test raporları
    5. Belgeleri ve dışa aktarımları işaretleme
    6. Proje gizlilik işaretini ayarlama
    7. Kuruluş gizlilik işaretini ayarlama
    8. Bir belgeye kendi gizlilik işaretini, kapak sayfasını ve sayfa numaralarını verme
    9. Gizlilik işaretlerinin yazdırıldığı yerler
  4. Model denetimleri
  5. İpuçları

Genel bakış

Holarch teslimatları modelden oluşturur; böylece bir belge her zaman arkasındaki gereksinimler, testler ve bağlantılarla eşleşir. İnceleyicilerin genellikle istediklerini üç araç karşılar:

  • Matris blokları: bir belgenin metni içinde, model her değiştiğinde güncellenen bir izlenebilirlik, doğrulama veya arayüz matrisi ya da test raporu.
  • Matrisi dışa aktar: aynı matrisler ve Test Raporu, geçerli modelden veya bir temel çizgiden, Excel, Word, CSV ya da web sayfası olarak ayrı bir dosyada.
  • Gizlilik işaretleri ve Sayfa yapısı: kuruluş, proje veya tek bir belge için her dışa aktarımda bir gizlilik işareti (şirket bildirimi, dağıtım beyanı, ihracat denetimi bildirimi, telif hakkı veya sözleşme numarası), ayrıca Word için kapak sayfası ve sayfa numaraları.

Metindeki canlı değerler ve tablolar Belgeler sayfasında anlatılır: Canlı değer… bir nesnenin tek bir özniteliğini, Sayı veya toplam… bir sorgudan hesaplanan bir sayıyı, Canlı tablo… bir sorgudan bir tabloyu, Çapraz başvuru… ise bir bölümün, şeklin veya tablonun geçerli numarasını ekler.

Kavramlar

Matrisler

MatrisSatırlarSütunlarBoşluk olarak vurgulanan
RTM (Gereksinim İzlenebilirlik Matrisi)GereksinimlerNumber, Requirement, Parent, Traced From, Traced To, Satisfied ByÜst öğesi olmayan ve izlendiği hiçbir şey olmayan bir gereksinim
Gereksinim Aşağı Akış MatrisiGereksinimlerNumber, Requirement, Flows Down From, Flows Down To, Derived RequirementsAlt öğesi ve türetilmiş gereksinimi olmayan en üst düzey bir gereksinim
Gereksinim Tahsis MatrisiGereksinimlerNumber, Requirement, Components, Functions, OtherHiçbir şeyin karşılamadığı bir gereksinim
Uygunluk matrisi (Resmî program açıkken gösterilir)Bir müşteri şartnamesinin gereksinimleriNumber, Requirement, Compliance, Response, Our Requirements and Design, Verification, Deviation/WaiverUygunluk beyanı olmayan bir gereksinim (Not assessed)
RVTM (Gereksinim Doğrulama İzlenebilirlik Matrisi)GereksinimlerNumber, Requirement, Method, Level, Verified By, StatusDoğrulama yöntemi veya doğrulayan test senaryosu yok
VCRM (Doğrulama Çapraz Başvuru Matrisi)GereksinimlerNumber, Requirement, Inspection, Analysis, Demonstration, Test, Verified By, StatusDoğrulama yöntemi seçilmemiş
Doğrulama Düzeyine Göre VCRMGereksinimlerNumber, Requirement, ardından her doğrulama düzeyi altında I, A, D ve T, Verified By, StatusDoğrulama yöntemi veya doğrulama düzeyi yok
Test RaporuBir test döngüsünün test senaryolarıNumber, Test Case, Verifies, Status, Actual Result, RunDöngüde geçmeyen bir test senaryosu
Tahsis Matrisiİşlevler (Action'lar)Number, Function, Performed ByHiçbir bileşenin gerçekleştirmediği bir işlev
Arayüz MatrisiBileşenler (Asset'ler)Aynı bileşenler; bir hücre, satır bileşeninden sütun bileşenine giden Conduit'leri listelerDiğerlerine veya diğerlerinden Conduit'i olmayan bir bileşen
N² Matrisiİşlevler (Action'lar)Aynı işlevler; bir hücre, satır işlevinin ürettiği ve sütun işlevinin aldığı Input/Output'ları listelerHiç girdi veya çıktı alışverişi yapmayan bir işlev
Özel MatrisBir arama sorgusundan nesnelerİkinci bir sorgudan nesneler; bir hücre ikisi arasındaki ilişkileri adlandırır veya seçilen tek bir ilişki için X gösterirHiçbir sütunla ilişkisi olmayan bir satır
  • Üst öğe, satırın decomposes ilişkisiyle ayrıştırdığı gereksinimdir. Traced From, Traced To ve Satisfied By ilgili nesneleri listeler. Aşağı akış matrisinde Derived Requirements, satırın traces to ilişkisiyle izlendiği gereksinimlerdir.
  • VCRM'de bir X her planlanan yöntemi işaretler; Durum, Test Merkezi'nde olduğu gibi test senaryolarından toplanan, o ana kadarki doğrulama sonucudur.
  • Doğrulama Düzeyine Göre VCRM'de sütunlar Verification Level özniteliğinin düzeylerine (Component, Subsystem, System) göre gruplanır. Gereksinimin düzeyi ve planlanan her yöntemi altında bir X bulunur.
  • Test senaryoları hiçbir zaman işlev olarak listelenmez: tahsis ve N² matrisleri Test Case olmayan Action'ları gösterir.
  • Kapsam: bir matris tek bir belgenin nesnelerini (belge sırası ve numaralandırmasıyla), bir derlemenin tüm bölümlerini veya projenin tamamını kapsar. Tahsis matrisi belgenin işlevlerini, belgede işlev yoksa tüm işlevleri kullanır. Arayüz ve N² matrisleri, I² ve N² diyagramlarında olduğu gibi tek bir Asset veya Action'ın alt öğelerini de kapsayabilir; projenin tamamı için Conduit'i veya Input/Output'u olan en fazla 120 bileşen ya da işlevi listeler. Özel matris en fazla 2.000 satır ve 120 sütun gösterir.
  • Test Raporu bloğu, bir test paketinin tek bir test döngüsünü veya geçerli sonuçlarını gösterir. Bkz. Test raporları.

Kopya değil, canlı

Bir matris bloğu satırları değil, yalnızca neyin gösterileceğini saklar. Belge her görüntülendiğinde veya dışa aktarıldığında Holarch satırları modelden yeniden oluşturur. Sonuç bir sonraki değişikliğe kadar önbellekte tutulur; böylece büyük projeler hızlı kalır.

Nasıl kullanılır

Belgeye matris ekleme

  1. Belgeyi açın ve belgenin veya bir öğenin açıklamasına tıklayın.
  2. Zengin metin araç çubuğunda +'yı açın ve Matris…'i seçin.
  3. Matris'i ve Kapsam'ı seçin. Kapsam açık belgeyle başlar.
    • Bir Özel Matris için Satırlar ve Sütunlar arama sorgularını girin (örneğin class:Requirement ve class:Asset), bir İlişki seçin veya Herhangi bir ilişki'yi koruyun ve isterseniz bir Başlık verin.
    • Bir Test Raporu için Test paketi'ni ve Test döngüsü'nü ya da Geçerli sonuçlar'ı seçin.

      Bir önizleme görürsünüz. Model her değiştiğinde güncellenir.

  4. Ekle'ye tıklayın.

    Matris metinde kesik çizgili bir çerçeveyle görünür. Başlığı matrisi, kapsamı ve kaç satırda boşluk olduğunu belirtir.

Matris hücre hücre düzenlenemez; bunun yerine modeli değiştirin. Kaldırmak için tabloyu düzenleyicide diğer içerikler gibi silin.

Matrisi dışa aktarma

  1. Bir belgede Teslim ▾'i açın ve İzlenebilirlik Matrisi…'ni seçin. Ya da Teslim ▾ → Tüm dışa aktarımlar…'ı seçin ve İzlenebilirlik matrisi (Excel), (Word), (CSV) veya (HTML)'i seçin.
  2. Matrisi dışa aktar içinde Matris'i ve Kapsam'ı seçin; Farklı dışa aktar içinde Matris (Excel), Matris (Word), Matris (CSV) veya Matris (HTML)'i seçin.
  3. İsteğe bağlı: Model içinde Geçerli model yerine bir temel çizgi seçin. Liste projenin temel çizgilerini ve seçilen belgenin temel çizgilerini gösterir.

    Alanların altındaki satır, satır sayısını ve boşluk içeren satırların sayısını verir.

  4. Dışa aktar düğmesine tıklayın.

    Bildirimde “Matris dışa aktarıldı.” yazar. Boşluklar Excel, Word ve web sayfasında kırmızıyla gölgelenir. Word ve web sayfası dışa aktarımları belgenin Sayfa yapısını kullanır. Word'de metin sütunları geniş, doğrulama yöntemi sütunları dardır; bunların başlıkları I, A, D ve T'dir ve tablonun altında bir açıklama bulunur (I = Inspection, A = Analysis, D = Demonstration, T = Test). Beşten fazla sütunlu matrisler yatay sayfa kullanır. Düzeye göre VCRM'nin düzeyleri içeren ikinci bir başlık satırı vardır; arayüz, N² ve özel matrisler satır başlıklarını ve köşegenlerini gölgelendirir.

Temel çizgiden matrisler

İmzalı bir teslimat modeli bugünkü haliyle değil, temel çizgiye alındığı haliyle göstermelidir. Bir temel çizgiden oluşturulan matris, temel çizginin nesnelerini ve ilişkilerini kullanır ve başlığı “(temel çizgi ad)” ile biter.

  • Matrisi dışa aktar: temel çizgiyi Model içinde seçin.
  • Bir proje temel çizgisi modelin tamamını tutar; bu nedenle her matris onunla çalışır.
  • Bir belge temel çizgisi belgeyi, öğelerini ve onlara bağlı nesneleri tutar. O belgenin matrisleri eksiksizdir. Belgenin dışına uzanan bir matris (projenin tamamı veya bir arayüz ya da N² matrisi) şu notu taşır: “Yalnızca o belgeyi ve ona bağlı nesneleri tutan bir belge temel çizgisinden oluşturuldu.”

Test raporları

Bir test raporu tek bir test döngüsünün sonuçlarını verir: neyin, hangi konfigürasyonda test edildiğini, neyin geçip neyin kaldığını ve bunun hangi gereksinimleri doğruladığını.

  1. Test Merkezi'nde Yeni döngü başlat… ile bir test döngüsü kaydedin. Konfigürasyon / Derleme ve Test ürünü bilgilerini girin (ikisi de çalıştırmada en sık kaydedilen değerlerle başlar).
  2. Paket kartında ⋯'yi açın ve Test raporu…'nu seçin. Ya da ⋯ → Test döngüleri…'ni açın ve bir döngüde Rapor…'a tıklayın.
  3. Test raporunu dışa aktar içinde Test döngüsü'nü ve Farklı dışa aktar içinde Test raporu (Word), (Excel), (CSV) veya (HTML)'i seçin, ardından Dışa aktar'a tıklayın.

Word raporunda (varsayılan) şu bölümler bulunur:

  1. Tanımlama: test paketi, test döngüsü, sonuçların ne zaman kaydedildiği ve raporun ne zaman oluşturulduğu.
  2. Test Ortamı ve Konfigürasyon: konfigürasyon veya derleme, test ürünü, test edenler ve çalıştırma tarihleri.
  3. Sonuçların Özeti: duruma göre sayılar ve geçme oranı.
  4. Test Senaryosuna Göre Sonuçlar: test senaryosu başına bir satır.
  5. Ayrıntılı Sonuçlar: test senaryosu başına beklenen ve gerçek sonuç, test eden, tarih, konfigürasyon, test ürünü, kanıt dosyası ve adım sonuçları.
  6. Sapmalar ve Açık Sorunlar: bağlı Issue'larıyla birlikte başarısız ve engellenmiş test senaryoları.
  7. Test Kanıtı: döngüde kaydedilen kanıt dosyaları.
  8. Gereksinim Doğrulama Durumu: paketin doğruladığı gereksinimler, bu döngünün sonuçlarına göre durumlarıyla.

Excel üç sayfa verir (Results, Steps, Requirements); CSV ve web sayfası sonuç tablosunu verir. Sonuçlar döngüden kaydedildiği haliyle gelir; bu nedenle paket sıfırlandıktan sonra rapor aynı kalır. Adlar, doğrulanan gereksinimler ve Issue'lar geçerli modelden gelir. Adım sonuçları ve kanıt tutulmaya başlanmadan önce kaydedilen döngüler bu alanları “—” olarak gösterir.

Sonuç tablosunu bir belgeye koymak için bir Test Raporu matris bloğu ekleyin (yukarıya bakın).

Belgeleri ve dışa aktarımları işaretleme

Gizlilik işareti, Holarch'ın dışa aktardığınız her şeye yazdırdığı metindir: her sayfanın üstünde bir üst bilgi, her sayfanın altında bir alt bilgi ve ilk sayfada bir bildirim. Bunu proje veya kuruluş için bir kez ayarlayın; her dışa aktarım onu taşır. Bir belge onu kendi işaretiyle değiştirebilir.

Not: Barındırılan hizmet (app.holarch.app) CUI, gizli veya ihracat denetimine tabi bilgileri tutamaz (Kullanım Koşulları). Orada standart liste Distribution Statement B ile F'yi ve ihracat denetimi bildirimini dışarıda bırakır; CUI'yi, bir gizlilik derecesini (SECRET//NOFORN gibi), ITAR, EAR veya ihracat denetimini ya da Distribution Statement B ile F'yi adlandıran bir gizlilik işareti kaydedilmez: “Holarch'ın barındırılan hizmeti CUI, gizli veya ihracat denetimine tabi bilgileri tutamaz; bu nedenle bu gizlilik işareti burada kullanılamaz. Kaldırın veya masaüstü uygulamasını ya da kendi sunucunuzdaki bir kurulumu kullanın.” Company Confidential gibi şirket bildirimleri, Distribution Statement A, telif hakkı ve sözleşme numaraları kullanılabilir kalır. Bu kuraldan önce ayarlanan gizlilik işaretleri korunur ve yazdırılmaya devam eder; birini değiştirmek için kısıtlı kısmı kaldırın.

Masaüstü uygulaması ve kendi sunucunuzdaki kurulumlar listenin tamamını sunar ve her gizlilik işaretini kabul eder. Gizlilik işaretleri sizin seçtiğiniz metinlerdir; Holarch bunları yazdırır ancak işleme kurallarını uygulamaz, kuruluşunuzun kendi denetimleri geçerlidir. Her sürümde, bir gizlilik işaretindeki ihracat denetimi bildirimi proje için YZ'yi kapatır.

Standart işaret listesi metni sizin için doldurur:

Standart işaretBaşlıkAlt bilgiBildirim
Company ProprietaryCOMPANY PROPRIETARYCOMPANY PROPRIETARYŞirket'i adlandıran bir mülkiyet bildirimi
Company ConfidentialCOMPANY CONFIDENTIALCOMPANY CONFIDENTIALŞirket'i adlandıran bir gizlilik bildirimi
Distribution Statement A ile F arası (B ile F: yalnızca masaüstü uygulaması ve kendi sunucunuz)(yok)DISTRIBUTION STATEMENT A to FBeyanın standart DoD ifadesi (DoDI 5230.24); Neden, Belirleme tarihi ve Denetleyen birim doldurulmuş olarak
İhracat denetimi bildirimi (ITAR/EAR) (yalnızca masaüstü uygulaması ve kendi sunucunuz)(yok)Export-controlled technical data. See the notice on the first page.Belgenin ITAR (22 CFR 120–130) veya EAR (15 CFR 730–774) kapsamında teknik veri içerebileceğine dair bir uyarı
Telif hakkı(yok)© Yıl Telif hakkı sahibi. All rights reserved.(yok)
Sözleşme numarası(yok)Contract No. Sözleşme numarası(yok)

Boş bıraktığınız bir doldurma alanı metinde [reason] gibi köşeli parantezli bir yer tutucu olarak kalır. Düzenleyici bu durumda “Dışa aktarmadan önce köşeli parantezli kısımları tamamlayın.” gösterir.

Proje gizlilik işaretini ayarlama

  1. ⌘K / Ctrl+K tuşlarına basın ve Proje gizlilik işareti…'ni seçin. Bunu bir belgedeki Sayfa yapısı…'ndan veya açık projenin Proje tercihleri…'nden (Ana sayfada Ana sayfa ▾) de açabilirsiniz.
  2. Kendi işareti'ni seçin.
  3. Standart işaret içinde bir giriş seçin, alanlarını doldurun (örneğin Şirket) ve İşarete ekle'ye tıklayın.

    Üst bilgi, Alt bilgi ve Bildirim'in doldurulduğunu görürsünüz. Birleştirmek için başka bir giriş ekleyin: üst ve alt bilgiler “ · ” ile birleştirilir ve her bildirim ayrı bir paragraf olur.

  4. Gerekirse metni düzenleyin, ardından Kaydet'e tıklayın.

    Bildirimde “Proje gizlilik işareti kaydedildi.” yazar. Proje gizlilik işaretini yalnızca proje sahipleri değiştirir; diğer üyeler onu salt okunur görür.

Temizle üç alanı boşaltır. İşaret yok, kuruluşun bir işareti olsa bile proje için gizlilik işaretini kapatır.

Kuruluş gizlilik işaretini ayarlama

  1. Hesap menüsünü açın, Kuruluş ayarları'nı seçin, ardından kuruluşu açın.
  2. Belge işareti altında İşareti düzenle…'ye tıklayın.
  3. Gizlilik işaretini bir projede olduğu gibi ayarlayın ve Kaydet'e tıklayın.

    Bildirimde “Kuruluş gizlilik işareti kaydedildi.” yazar. Kendi gizlilik işareti olmayan kuruluşun her projesi için geçerlidir. Yalnızca kuruluş yöneticileri onu değiştirir.

Bir belgeye kendi gizlilik işaretini, kapak sayfasını ve sayfa numaralarını verme

  1. Bir belgede Teslim ▾'i açın ve Sayfa yapısı…'nı seçin.
  2. Gizlilik işareti altında birini seçin:
    • Proje veya kuruluş işareti (varsayılan): alttaki satır belgenin kullandığı gizlilik işaretini belirtir.
    • Kendi işareti: üst bilgiyi, alt bilgiyi ve bildirimi bir projede olduğu gibi ayarlayın.
    • İşaret yok: belge ve dışa aktarımları hiçbir işaret taşımaz.
  3. Geri kalanı doldurun:
    • Sürüm ve Hazırlayan ile Kapak sayfası. Kapak sayfası bildirimi de gösterir.
    • Word dışa aktarımlarında Sayfa numaraları (“Sayfa X / Y”).
  4. Uygula düğmesine tıklayın.

    Bildirimde “Sayfa yapısı kaydedildi.” yazar. Üst ve alt bilgi belgenin üstünde ve altında, bildirim ise başlığının altında görünür. ⌘Z / Ctrl+Z değişikliği tek adımda geri alır.

En yakın gizlilik işareti geçerli olur: belgenin kendi işareti, yoksa projeninki, o da yoksa kuruluşunki.

Gizlilik işaretlerinin yazdırıldığı yerler

  • Belge görünümü ve Yazdır veya PDF…: her sayfanın üstünde ve altında üst ve alt bilgi, başlığın altında bildirim.
  • Word dışa aktarımı (Teslim ▾ → {template} (Word) veya Tüm dışa aktarımlar… içindeki Belge (Word)): üst ve alt bilgi, seçildiyse sayfa numaralarıyla birlikte her sayfada tekrarlanır; kapak sayfası düz başlığın yerini alır. Belgedeki canlı bir matris bloğu, başlığı üstünde, aynı sütun genişlikleri ve I/A/D/T başlıklarıyla, boşlukları kırmızıyla gölgelenmiş bir Word tablosuna dönüşür.
  • Matrisi dışa aktar ve İzlenebilirlik matrisi (Word) veya (HTML).
  • Diğer Word dosyaları: ICD belgesi, sunu, diyagram ve Ayrıştırma (Word) dışa aktarımları üst ve alt bilgiyi her sayfada, bildirimi başlığın altında taşır.
  • Excel raporları: üst ve alt bilgi her sayfanın sayfa üst ve alt bilgisine girer; Excel bunları Sayfa Düzeni görünümünde gösterir ve yazdırır.
  • CSV: yalnızca Tablo (CSV) içinde İlk satır olarak gizlilik işareti kutusunu işaretlediğinizde. Varsayılan olarak kapalıdır; böylece dosya olduğu gibi yeniden içe aktarılır.
  • Diyagram resimleri: PNG ve SVG dışa aktarımları diyagramın üstünde üst bilgiyi içeren bir bant ve altında alt bilgiyle bildirimi içeren bir bant alır. Web sayfası (HTML) dışa aktarımları bunları sayfanın üstünde ve altında gösterir. Küçük resimler ve belgelerin içindeki diyagram resimleri işaretsiz kalır.
  • Sunular: PowerPoint, web sayfası, PNG ve SVG slaytları üst ve alt bilgiyi her slaytta, bildirimi ilk slaytta gösterir.
  • Bir derlemenin, derlemeyi dışa aktardığınızda kullanılan kendi Sayfa yapısı vardır.

Model denetimleri

Model denetimleri, silinmiş bir şeye işaret eden canlı bir değeri veya canlı tabloyu bildirir (kural Global.7, “Eksik hedeflere işaret eden canlı değerler”):

  • Nesnesi silinmiş bir Canlı değer “{Entity: … Not found}” gösterir.
  • Kapsam belgesi silinmiş bir matris bloğu, test paketi veya test döngüsü silinmiş bir Test Raporu bloğu ya da ilişkisi artık var olmayan bir Özel Matris.
  • Sorgusu var olmayan bir sınıfı, etiketi, ilişkiyi veya belgeyi adlandıran bir Sayı veya toplam ya da Canlı tablo.
  • Öğesi, şekli veya tablosu silinmiş bir Çapraz başvuru.

Açıklamayı açın, ardından canlı değeri düzenleyin veya kaldırın ya da var olan bir hedef için yeniden ekleyin. Bkz. Model denetimleri.

İpuçları

  • RVTM'yi veya VCRM'yi bir şartnamenin sonuna doğrulama bölümü olarak koyun; incelemeye kadar güncel kalır.
  • Bir inceleme paketi için bir derleme oluşturun ve ona kendi Sayfa yapısında bir kapak sayfası ve gizlilik işareti verin.
  • VCRM'yi üzerinde işaretleme yapacak bir inceleme kurulu için Excel'e dışa aktarın ve canlı bloğu belgede tutun.
  • Entegrasyon düzeyine göre düzenlenmiş bir doğrulama planı için Doğrulama Düzeyine Göre VCRM'yi kullanın ve önce her gereksinimin Doğrulama düzeyi'ni ayarlayın.
  • Bir arayüz kontrol belgesi için kapsamı sistem Asset'i olan bir Arayüz Matrisi ekleyin; böylece alt öğeleri ve onların Conduit'leri köşegende ve hücrelerde görünür.