Ezen az oldalon

Dokumentációs sablonok

Process Architecture Process Architecture Process Architecture licenccel vagy magasabb csomaggal érhető el. Csak az ezt vagy magasabb csomagot használók férhetnek hozzá ehhez a funkcióhoz. Csomagok összehasonlítása Folyamatarchitektúra felhasználói hellyel vagy magasabb csomaggal érhető el

A ProcessMindben minden létrehozott dokumentum egy dokumentációs sablon alapján készül. Az alkalmazásban ezek neve Dokumentációs sablonok. A sablon határozza meg a dokumentum részeit és azok sorrendjét: a címlapot, a tartalomjegyzéket, a fejezeteket és szakaszokat, a szövegtömböket, a dokumentációs mezőket, a modellt, a RACI-mátrixot, az elemek dokumentációját, a diagramokat és a tevékenységenkénti RACI-hozzárendelést.

Minden folyamatarchitektúra-szinthez külön sablonok tartoznak. Így ugyanazt a folyamatot eltérő formában mutathatja be egy rövid áttekintésben, egy részletes SOP-ban vagy egy auditcsomagban.

Hol találhatók a sablonok

  • A Beállítások → Folyamatarchitektúra oldalon minden szint külön kártyán jelenik meg. A szerkesztő megnyitásához kattintson a szint Dokumentációs sablonok címkéjére vagy a szerkesztés ikonra.
  • A Dokumentáció lapon az oldalsáv Dokumentációs sablon választójával válthat a megtekintett dokumentumok között. A rendszer a szint alapértelmezett sablonját használja, amíg valaki másikat nem választ.
  • A szerkesztők közvetlenül a dokumentumból is megnyithatják a hozzá tartozó sablont: nyissa meg az exportálási menüt, és válassza a Sablon szerkesztése… lehetőséget.

A sablonokat a Folyamatarchitektúra beállításai között konfigurálhatja. A folyamat dokumentációját megtekintő felhasználók a sablon alapján készült dokumentumot látják. Minden exportálás a dokumentációs oldalon kiválasztott sablont használja.

Sablonok kiválasztása és kezelése

A szerkesztő egyetlen párbeszédablakból áll: felül található a sablonválasztó és a hozzáadás gomb, bal oldalon a dokumentumfa, jobb oldalon pedig a kiválasztott elem beállításai. Alul a Mégse és a Mentés gomb látható.

A szerkesztő az adott szinten legutóbb módosított sablonnal nyílik meg. A dokumentációs oldalon a Sablon szerkesztése… lehetőség megnyitja az aktuális dokumentumhoz használt sablont.

  • A szint sablonjai között felül, a Dokumentumsablon választóval válthat. A Piszkozat jelölésű sablonokat a megtekintők nem látják. Az Alapértelmezett jelölés mutatja, melyik sablappal nyílik meg a dokumentációs oldal.
  • A + gomb létrehoz egy Új dokumentumsablon nevű sablont, és ki is jelöli azt.
  • A Név mezővel átnevezheti a kijelölt sablont.
  • A Közzétéve beállítással szabályozhatja, hogy a megtekintők kiválaszthatják-e a sablont a dokumentációs oldalon. A szerkesztők a piszkozatokat is látják.
  • A Beállítás alapértelmezettként gombbal megadhatja, hogy a dokumentációs oldal ezt a sablont használja, ha nincs másik kiválasztva. Minden szinthez egy alapértelmezett sablon tartozik.
  • A Dokumentumsablon törlése eltávolítja a kijelölt sablont. Egy szint egyetlen alapértelmezett sablonját nem törölheti. Először állítson be egy másik sablont alapértelmezettként.
  • A Dokumentáció nélküli elemek felvétele beállítással a dokumentum elemeket felsoroló részéhez adhatja azokat a modellelemeket, amelyeknek még nincs leírásuk. Kapcsolja ki, ha a dokumentumban csak a kész dokumentációt szeretné felsorolni.

A sablon hozzáadása, törlése és alapértelmezettként való beállítása azonnal érvénybe lép. A nevet, a láthatóságot, a tartalomfelvételi beállítást, a címlapot és a dokumentumfát a Mentés gombbal mentheti.

A dokumentum felépítése

A szerkesztő bal oldalán található a dokumentumfa. Húzással átrendezheti az elemeket, vagy egy fejezetre, illetve szakaszra ejtve beágyazhatja őket. Tartalom hozzáadásához vagy eltávolításához használja a sor menügombját, vagy kattintson a sorra a jobb egérgombbal.

Fejezetek és szakaszok

  • Az Alfejezet hozzáadása alul lehetőséggel új fejezetet adhat a dokumentum legfelső szintjéhez.
  • Az Szakasz hozzáadása vagy a Szakasz hozzáadása alul lehetőséggel beágyazott vagy azonos szintű szakaszt adhat hozzá.
  • Válasszon ki egy fejezetet vagy szakaszt a Cím szerkesztéséhez és az Automatikus számozás be- vagy kikapcsolásához. A számozás a fa szerkezetét követi: a fejezetek száma X, a hozzájuk tartozó szakaszoké X.Y, a mélyebben beágyazott szakaszoké pedig X.Y.Z. A panelen látható, milyen címsorszintként jelenik meg az elem.
  • A Törlés eltávolítja a kijelölt elemet és annak alárendelt elemeit.

Tartalmi elemek

Az elem menüjében a következő lehetőségek találhatók:

  • Szöveg hozzáadása / Szöveg hozzáadása alul: Markdown-szövegblokkot ad hozzá. A Markdown-szöveg mezőben címsorokat, listákat, hivatkozásokat és megjegyzéseket írhat. Itt helyőrzőket is használhat.
  • Az Dokumentációs mező hozzáadása… / Dokumentációs mező hozzáadása alul… lehetőséggel az adott szint közzétett dokumentációs mezői közül adhat hozzá egyet. Ha egy mező később már nem közzétett, a rendszer eltávolítja a dokumentumból, így az nem jelenít meg olyan tartalmat, amelyet az adott szint már nem tesz közzé.
  • Az Modell hozzáadása / Modell hozzáadása alul lehetőséggel megjelenítheti a folyamatdiagramot. A Adatok megjelenítése beállítás a diagram alatt megjeleníti a „Használt szűrők és adatok” összefoglalót.
  • A RACI hozzáadása / RACI hozzáadása alul lehetőséggel megjelenítheti a RACI-mátrixot.
  • Az Elemek hozzáadása / Elemek hozzáadása alul lehetőséggel megjelenítheti az összes modellelem dokumentációját.
  • A Diagramok szakasz hozzáadása lehetőséggel a dokumentum kívánt pontjára helyezheti a diagramok dokumentációját. A dokumentum legfelső szintjén, valamint bármely fejezeten vagy szakaszon belül használható.
  • A Tevékenységenkénti RACI hozzáadása lehetőséggel minden tevékenység RACI-hozzárendelése bekerül az elemeket tartalmazó szakaszba. Ha a dokumentum legfelső szintjén adja hozzá, a teljes dokumentumra érvényes.

A Címlap hozzáadása és a Tartalomjegyzék hozzáadása lehetőség csak a dokumentum legfelső szintjén jelenik meg, és mindkettőből csak egy adható hozzá. Mindkettő külön elem: válassza ki a szerkesztéshez, vagy törölje, ha nincs szüksége címlapra vagy tartalomjegyzékre.

A címlap

A beállítások megadásához válassza ki a címlap elemét:

  • A háttérképhez használja a Kép feltöltése, a Csere lehetőséget vagy az eltávolítás ikont.
  • A Cím alapértelmezés szerint a folyamat neve. Helyőrzőkkel olyan címet adhat meg, amely a folyamattal együtt változik.
  • Az Alcím mezőbe verziót, besorolást vagy célközönséget írhat.

Helyőrzők

A szerkeszthető szövegben helyőrzőket használhat. A ProcessMind a dokumentum létrehozásakor tölti ki őket:

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

Kattintson egy helyőrzőre a másolásához, vagy kattintson rá duplán, hogy beszúrja a szerkesztett szövegbe. Ha egy helyőrzőhöz nincs érték a folyamatnál, a dokumentumban üresen jelenik meg.

Sablonok és exportálás

A sablon határozza meg a dokumentum tartalmát. A PDF-, Word- és Markdown-export, valamint a nyomtatás is a kiválasztott sablont követi. Ami nem szerepel a sablonban, az az exportból is kimarad. Ha egy adott sablonból ki szeretne hagyni egy részt, törölje a hozzá tartozó elemet. Ha egy folyamatarchitektúra-szinthez többféle dokumentumot szeretne, készítsen mindegyikhez külön sablont, majd állítsa alapértelmezettként azt, amellyel a dokumentációs oldal megnyíljon.

Kapcsolódó témák

Tervezzen jobb folyamatokat. Építsen összekapcsolt architektúrát. Tartsa kézben a működést.

Azonnal hozzáférhet, bankkártya és várakozás nélkül. Alakítsa szervezete működését világos, összekapcsolt folyamatmodellekké.

Építse fel folyamatarchitektúráját, határozza meg a felelősségi köröket és az ellenőrzéseket, és hangolja össze a szerepeket minden szinten.

Indítsa el az ingyenes próbaverziót, és teremtsen megbízható alapot folyamatainak irányításához, kezeléséhez és folyamatos fejlesztéséhez.