Wprowadzenie

Ostatnio coraz częściej tworzę dokumenty w Confluence. W tym artykule chciałbym podzielić się z wami jak tworzę takie dokumenty z wykorzystaniem AI. Podczas opisywania procesów biznesowych często wspieram się Mermaid. Jest to format wykorzystywany do tworzenia diagramów i wykresów. Do wizualizacji tych diagramów w Confluence korzystam z Draw.io.

Dla osób które gardzą rozwiązaniem Confluence, przygotowałem również wizualizacje, jak tworzyć identyczne dokumenty w Notion.

Od czego zacząć?

Załóżmy, że chcesz stworzyć dokumentację procesu biznesowego. Dla przykładu będziemy tworzyć dokumentację procesu OAuth 2.0. Pierwszym krokiem będzie zgromadzenie albo stworzenie surowych notatek, które to będą podstawą do stworzenia dokumentu. Zapraszam do zapoznania się z artykułem Tworzenie schludnych dokumentów z surowych materiałów, gdzie przedstawiam proces tworzenia dokumentu z surowych notatek.

A tutaj jest prosta wizaliazacja tego procesu:

Podczas tworzenia confluence page przydzą nam się zarówno notatki w postaci markdkown jak i dokument w formacie docx.

Confluence

Mam piękne notatki, co dalej?

Teraz wystarczy zaimportować notatki.
Markdown jest świetnym formatem dla dokumentów, ale Confluence radzi sobie z nim słabo.

Zdecydowanie lepiej sprawdza się plik w formacie docx.

Diagramy

Natomiast do generowania diagramów mermaid, notatki w formacie markdown są idealne! W tym celu stworzyłem customową wersję GPT, która to zamienia notatki w formacie markdown na diagramy mermaid.

Czasami AI ma problemy z rozpoznaniem diagramów, ale w większości przypadków radzi sobie dobrze. Gdyby jednak wasz diagram wyglądał niekorzystnie, zawsze możecie przejrzeć dokumentację Mermaid, oraz zasugerować AI jaki typ diagramu chcecie uzyskać.

W celu szybkiej wizualizacji diagramów korzystam z mermaid.live. Możecie tam na bieżąco edytować diagramy mermaid.

Po dokonaniu zmian w diagramie, wystarczy tylko zaimportować go do confluence. Można zrobić zrzut ekranu, albo skorzystać z draw.io.

Korzystam również z Expand Macro w confluence, które pozwala na zwinięcie długich diagramów.

A tak wygląda gotowa dokumentacja:

Notion

Dla rozwiązania Notion, proces jest prostszy, ponieważ Notion radzi sobie z markdown jak i diagramami mermaid wyśmienicie.

Kroki są bardzo podobne jak w przypadku Confluence.

1. Stworzenie notatek w formacie markdown, format docx jest tutaj zbędny.
2. Zaimportowanie notatek do Notion.
3. Stworzenie diagramów w mermaid na podstawie notatek markdown z wykorzystaniem customowej wersji GPT.
4. Zaimportowanie diagramów do Notion.

Podsumowanie

Takie podejście ułatwia mi tworzenie wartościowej dokumentacji. Dodatkowo wizualizacja procesów biznesowych za pomocą diagramów Mermaid pozwala na szybsze zrozumienie procesów przez innych, najczęściej tych którzy nie mają czasu na czytanie długich dokumentów. Aktualizacja takich diagramów jest również prosta. Wystarczy stworzyć prompt, który to będzie zawierał informacje o zmianach w procesie, jako załącznik dołączyć zdjęcie diagramu lub surową postać markdown, a AI wygeneruje nowy diagram.

Rozwiązanie Notion lepiej radzi sobie z importowaniem markdown, jak i z diagramami mermaid. Brawo Notion! Confluence wymaga więcej pracy, aby uzyskać podobne rezultaty, ale również daje radę.

Ciekawym pomysłem jest wykorzystanie wbudowanych narzędzi systemowych speach-to-text dla Windows czy Mac, a następnie przekształcenie takich surowych notatek przez AI, aby uzyskać ustrukturyzowane notatki w formacie markdown.