Visual Paradigm z przyjemnością ogłasza ważne ulepszenie dla Visual Paradigm OpenDocs: użytkownicy mogą teraz tworzyć i wstawiać edytowalne diagramy bezpośrednio do stron dokumentów dzięki integracji z Visual Paradigm VPasCode.
Ta nowa funkcja łączy dokumentację i tworzenie diagramów w jednym zoptymalizowanym przepływie pracy. Zamiast tworzyć diagram w oddzielnej aplikacji, eksportować go jako obraz i ręcznie umieszczać ten obraz w dokumencie, użytkownicy mogą teraz tworzyć diagram przy użyciu diagramu jako kodu, wstawiać go do OpenDocs i ponownie otwierać go do edycji, gdy zajdzie taka potrzeba.
Wynikiem jest bardziej elastyczne narzędzie do zarządzania wiedzą dla zespołów programistycznych, pisarzy technicznych, architektów, analityków biznesowych, menedżerów produktów i wszystkich, którzy muszą wizualnie wyjaśniać złożone koncepcje.
Otwórz Visual Paradigm OpenDocs i zacznij tworzyć dokumentację z edytowalnymi diagramami już dziś.
Co nowego w Visual Paradigm OpenDocs?
OpenDocs umożliwia teraz użytkownikom wstawianie diagramów do strony dzięki integracji z VPasCode. Diagram jest dodawany w miejscu kursora tekstowego i można go ponownie edytować po wstawieniu.
Oznacza to, że diagramy nie są już ograniczone do statycznych obrazów dodawanych po zakończeniu procesu pisania. Mogą stać się aktywnymi, edytowalnymi częściami dokumentu, które wspierają wyjaśnianie, współpracę, planowanie, analizę i dzielenie się wiedzą.
Niezależnie od tego, czy przygotowujesz specyfikację wymagań oprogramowania, tworzysz wewnętrzną wiki projektu, dokumentujesz architekturę systemu, publikujesz przewodnik procesowy, czy budujesz bazę wiedzy o produkcie, możesz teraz łączyć treści tekstowe i modele wizualne w tym samym dokumencie.
Dlaczego to ulepszenie ma znaczenie
Dokumenty są często bardziej użyteczne, gdy łączą jasne wyjaśnienia z diagramami. Opisy tekstowe dostarczają kontekstu i szczegółów, podczas gdy diagramy pomagają czytelnikom zrozumieć relacje, sekwencje, zależności, struktury i przepływy pracy na pierwszy rzut oka.
Jednak tworzenie i utrzymywanie diagramów w dokumentacji może być niewygodne. Typowy przepływ pracy obejmuje użycie jednego narzędzia do stworzenia diagramu, eksportowanie wyniku jako pliku PNG lub SVG, wgranie obrazu do dokumentu i powtarzanie procesu za każdym razem, gdy diagram ulega zmianie. Może to generować niepotrzebną pracę i prowadzić do przestarzałych wizualizacji, zduplikowanych plików lub zamieszania dotyczącego tego, która wersja jest najnowsza.
Integracja OpenDocs i VPasCode zmniejsza ten problem, przenosząc tworzenie diagramów bliżej przepływu pracy dokumentacyjnego. Użytkownicy mogą tworzyć diagram tam, gdzie jest on potrzebny, wstawiać go do strony i wracać do edytora diagramów później w celu wprowadzenia poprawek.
Zachowuj wyjaśnienia wizualne blisko odpowiedniej treści
Diagram jest najbardziej skuteczny, gdy pojawia się obok wyjaśnienia, które wspiera. Dzięki nowej funkcji OpenDocs użytkownicy mogą umieścić schemat blokowy poniżej opisu procesu, dodać diagram sekwencji obok wyjaśnienia interfejsu API lub włączyć diagram architektury systemu w specyfikacji technicznej.
To sprawia, że dokumenty są łatwiejsze do czytania i pomaga użytkownikom zrozumieć relację między informacjami tekstowymi a wizualnymi bez przełączania się między wieloma aplikacjami.
Zmniejsz pracę ręcznego eksportowania i wgrywania
VPasCode tworzy diagramy na podstawie tekstowych języków diagramów i renderuje je wizualnie w przeglądarce. Dzięki integracji z OpenDocs użytkownicy mogą wstawiać wynik bezpośrednio do strony zamiast ręcznie pobierać obraz i wgrywać go do dokumentu.
Zmniejszenie tych powtarzalnych kroków może pomóc zespołom zaoszczędzić czas i utrzymać czystszy proces dokumentacji, zwłaszcza gdy diagramy są często aktualizowane podczas rozwoju lub planowania projektu.
Uczyń diagramy edytowalnymi po wstawieniu
Wymagania się zmieniają. Systemy ewoluują. Procesy biznesowe są rewidowane. Diagram, który dziś dokładnie opisuje projekt, może wymagać aktualizacji jutro.
Ponieważ diagramy wstawione za pomocą VPasCode pozostają edytowalne, użytkownicy mogą ponownie otworzyć edytor diagramów z OpenDocs, zmodyfikować kod diagramu, zapisać zmiany i odświeżyć diagram w dokumencie. Ułatwia to dopracowanie treści wizualnych w miarę rozwoju idei i projektów.
Wsparcie dla więcej niż jednego stylu diagramowania
Różne projekty wymagają różnych rodzajów komunikacji wizualnej. Architekt oprogramowania może potrzebować modelu C4 lub diagramu wdrożenia. Analityk biznesowy może potrzebować schematu blokowego procesu lub mapy podróży użytkownika. Menedżer projektu może potrzebować wykresu Gantta lub mapy drogowej. Pisarz techniczny może potrzebować mapy myśli, diagramu sekwencji lub diagramu relacji encji.
VPasCode obsługuje szeroki zakres formatów diagramów i technologii wizualizacji, w tym PlantUML, Mermaid, Graphviz, D2, Markmap i ECharts. Obsługuje również dane strukturalne i inne formaty oparte na kodzie, które można wykorzystać do tworzenia reprezentacji wizualnych.
Czym jest Visual Paradigm VPasCode?
Visual Paradigm VPasCodeto platforma typu diagram-as-code w chmurze, która umożliwia użytkownikom tworzenie diagramów poprzez pisanie opisów tekstowych. Łączy edytor kodu z podglądem wizualnym w czasie rzeczywistym, pozwalając użytkownikom widzieć diagram w miarę pisania lub modyfikowania kodu.
Zamiast ręcznie rysować każdy kształt i połączenie, użytkownicy opisują strukturę diagramu, używając obsługiwanego składni. VPasCode następnie renderuje wynik jako wizualny diagram.
To podejście jest szczególnie przydatne dla programistów, architektów oprogramowania, zespołów technicznych i innych użytkowników, którzy chcą szybkiego i powtarzalnego sposobu tworzenia diagramów. Jest również pomocne dla zespołów, które preferują diagramy, które można przeglądać i udoskonalać jako tekst.
VPasCode zawiera przykłady dla różnych typów i formatów diagramów, co ułatwia początkującym użytkownikom rozpoczęcie pracy. Użytkownicy mogą również wykorzystać sztuczną inteligencję do generowania kodu diagramuna podstawie opisu w języku potocznym.
Obsługiwane formaty diagramów i wizualizacji
Poprzez VPasCode użytkownicy OpenDocs mogą tworzyć i wstawiać wiele różnych rodzajów diagramów i wizualizacji. Obsługiwane formaty obejmują:
- PlantUML: Diagramy klas, diagramy sekwencji, diagramy przypadków użycia, diagramy aktywności, diagramy komponentów, diagramy wdrożeń, diagramy stanów, diagramy ER, diagramy ArchiMate, modele C4, mapy myśli, wykresy Gantta i wiele innych.
- Mermaid: Schematy blokowe, diagramy klas, diagramy sekwencji, diagramy relacji encji, diagramy stanów, mapy myśli, diagramy C4, wykresy Gantta, osie czasu, mapy podróży użytkowników, wykresy Git, diagramy Kanban i wiele innych.
- Graphviz: Wykresy, diagramy sieciowe, diagramy hierarchiczne, schematy organizacyjne i wizualizacje relacji.
- D2: Nowoczesne deklaratywne diagramy dla architektury, systemów, przepływów pracy i relacji.
- Markmap: Interaktywne mapy myśli generowane z treści w stylu Markdown.
- ECharts: Wykresy i wizualizacje oparte na danych.
- Formaty danych i schematów: JSON, YAML, XML, CSV, TOML, DBML oraz SQL.
Ten zakres obsługiwanych technologii sprawia, że OpenDocs jest bardziej zaawansowaną platformą dokumentacyjną dla zespołów, które muszą tworzyć zarówno tradycyjne wizualizacje biznesowe, jak i diagramy techniczne.
Tworzenie diagramów wspomagane przez AI
Użytkownicy nie muszą zapamiętywać każdej składni diagramów przed rozpoczęciem pracy. VPasCode zawiera funkcję generowania diagramów wspieraną przez AI, która może pomóc przekształcić proste żądanie w języku naturalnym w kod diagramu.
Na przykład użytkownik może zapytać:
Stwórz diagram sekwencji pokazujący logowanie klienta przez aplikację internetową, usługę uwierzytelniania i bazę danych.
VPasCode może wykorzystać to żądanie do wygenerowania kodu diagramu, który użytkownicy mogą przeglądać, dostosowywać i wstawiać do OpenDocs. Następnie użytkownicy mogą ręcznie udoskonalić kod lub poprosić AI o modyfikację diagramu zgodnie z nowym wymaganiem.
Wspomaganie przez AI może być przydatne, gdy:
- Wiesz, co chcesz przekazać, ale nie znasz wymaganej składni.
- Chcesz szybko stworzyć wstępny diagram.
- Musisz dodać lub usunąć kroki, komponenty, relacje lub gałęzie.
- Chcesz uprościć złożony diagram.
- Potrzebujesz pomocy w korygowaniu błędów w kodzie diagramu.
- Chcesz przetłumaczyć etykiety diagramu dla międzynarodowego zespołu.
Diagramy wygenerowane przez AI pozostają edytowalne, co oznacza, że użytkownicy mogą traktować wygenerowany wynik jako punkt wyjścia i dostosować go do wymagań swojego projektu.
Jak wstawić edytowalny diagram na stronę OpenDocs
Wykonaj następujące kroki, aby utworzyć i wstawić diagram na stronę dokumentu:
- Otwórz Visual Paradigm OpenDocs.
- Utwórz nową stronę lub otwórz istniejącą stronę.
- Kliknij Edytuj w prawym górnym rogu strony.
- Umieść kursor tekstu w miejscu, gdzie ma pojawić się diagram.
- Kliknij + przycisk na pasku narzędzi, aby otworzyć Utwórz artefakt okno.
- Wybierz VPasCode z menu po lewej stronie.
- Kliknij VPasCode po prawej stronie, aby otworzyć edytor diagramów.
- Wpisz lub wklej kod diagramu w edytorze po lewej stronie.
- Przejrzyj podgląd w czasie rzeczywistym i wprowadź ewentualne niezbędne zmiany.
- Kliknij Zapisz w prawym górnym rogu edytora VPasCode.
- Kliknij Zamknij aby powrócić do strony OpenDocs.
- Diagram zostanie wstawiony w miejscu kursora tekstowego.
Po wstawieniu diagramu użytkownicy mogą kontynuować pisanie wokół niego tak, jakby robili to z innymi treściami dokumentu.
Jak ponownie edytować diagram
Diagramy wstawione do OpenDocs można edytować w dowolnym momencie, gdy wymagane są aktualizacje.
- Otwórz stronę OpenDocs zawierającą diagram.
- Kliknij ikonę ołówka w prawym górnym rogu diagramu.
- Wprowadź zmiany w edytorze VPasCode.
- Użyj podglądu na żywo, aby sprawdzić wynik.
- Kliknij Zapisz.
- Kliknij Zamknij aby powrócić do OpenDocs.
Zaktualizowany diagram odświeży się w dokumencie, co pozwoli użytkownikom zachować swoją treść wizualną bez usuwania oryginalnego diagramu lub rozpoczynania pracy od zera.
Praktyczne przypadki użycia
Dokumentacja architektury oprogramowania
Architekci oprogramowania mogą używać składni PlantUML, Mermaid, D2 lub C4 do opisywania komponentów systemu, usług, magazynów danych i zewnętrznych zależności. Powstały diagram architektury można umieścić bezpośrednio w dokumencie projektu systemu lub w rejestrze decyzji architektury.
W miarę zmian w architekturze diagram można edytować w VPasCode i aktualizować w OpenDocs. Pomaga to utrzymać dokumentację techniczną w zgodności z omawianym projektem.
Dokumentacja API i integracji
Diagramy sekwencji są przydatne do pokazania, jak klienci, usługi, bazy danych i systemy zewnętrzne ze sobą współpracują. Zespoły mogą dołączyć diagram sekwencji obok opisów API, szczegółów uwierzytelniania, przepływów żądań i zasad obsługi błędów.
Na przykład pisarz techniczny może udokumentować proces płatności online za pomocą opisu tekstowego, przykładów API oraz diagramu sekwencji Mermaid lub PlantUML na tej samej stronie OpenDocs.
Dokumentacja baz danych i modeli danych
Zespoły baz danych mogą używać diagramów relacji encji do wyjaśniania tabel, pól, kluczy i relacji. Wizualny model danych może sprawić, że dokumentacja baz danych będzie łatwiejsza do zrozumienia dla programistów, analityków, testerów i innych zainteresowanych stron.
Gdy dodana zostanie nowa tabela lub relacja, diagram można edytować i ponownie wstawić za pomocą tego samego przepływu pracy VPasCode.
Przewodniki po procesach biznesowych i przepływach pracy
Analitycy biznesowi i zespoły operacyjne mogą używać schematów blokowych, diagramów aktywności, map podróży użytkowników i diagramów procesów do wyjaśnienia, jak praca przepływa przez organizację.
Osadzenie tych wizualizacji w przewodniku operacyjnym lub standardowej procedurze operacyjnej może pomóc czytelnikom zrozumieć odpowiedzialności, punkty decyzyjne, alternatywne ścieżki i kroki zatwierdzania.
Wymagania produktowe i planowanie funkcji
Kierownicy produktów mogą dołączać do dokumentów wymagań produktowych podróże użytkowników, przepływy procesów, diagramy stanów, mapy myśli i relacje funkcji. Te zasoby wizualne mogą pomóc zespołom produktowym, projektowym, inżynieryjnym i kontroli jakości w wypracowaniu wspólnego zrozumienia funkcji.
Wiki projektowe i bazy wiedzy
Narzędzie do zarządzania wiedzą jest najbardziej wartościowe, gdy łączy informacje niezbędne do zrozumienia i wykonywania pracy. Dodanie edytowalnych diagramów do bazy wiedzy OpenDocs może sprawić, że wiki projektowe, materiały wdrażania, wewnętrzne przewodniki i instrukcje systemowe będą bardziej kompletne.
Zamiast przechowywać diagramy w oddzielnych folderach lub niezwiązanych narzędziach projektowych, zespoły mogą umieszczać je obok powiązanych wyjaśnień, decyzji, procedur i materiałów referencyjnych.
Mapy myśli i organizacja koncepcji
Markmap i inne formaty map myśli mogą pomóc zespołom w organizacji wymagań, tematów badawczych, struktur projektów, wyników spotkań i hierarchii wiedzy. Te mapy można wstawić na stronę OpenDocs, aby zapewnić wizualne podsumowanie przed przedstawieniem bardziej szczegółowych informacji.
Korzyści dla różnych typów użytkowników
- Programiści:Twórz diagramy za pomocą znanych formatów tekstowych i utrzymuj wyjaśnienia techniczne blisko wizualizacji systemu.
- Architekci oprogramowania:Twórz diagramy architektury, UML, C4, wdrożenia i komponentów, które można aktualizować w miarę ewolucji systemów.
- Pisarze techniczni:Łącz procedury, specyfikacje, przykłady i edytowalne diagramy w jednym środowisku dokumentacji.
- Analitycy biznesowi:Wyjaśniaj procesy biznesowe, wymagania, decyzje i podróże użytkowników za pomocą jasnych modeli wizualnych.
- Kierownicy produktów:Dodawaj przepływy pracy, mapy drogowe, relacje funkcji i przepływy użytkowników do dokumentacji produktu.
- Zespoły projektowe:Twórz udostępnianą dokumentację, która przekazuje zarówno szczegóły, jak i ogólny obraz.
- Nauczyciele i trenerzy:Używaj diagramów, aby ułatwić zrozumienie treści technicznych lub proceduralnych.
Od statycznych dokumentów do żywej dokumentacji
Skuteczna dokumentacja powinna odzwierciedlać aktualny stan projektu, produktu, procesu lub systemu. Gdy treści wizualne są przechowywane wyłącznie jako statyczny obraz, ich aktualizacja może być łatwo odkładana. Z czasem obraz może przestać odzwierciedlać rzeczywistość.
Integracja OpenDocs i VPasCode wspiera bardziej utrzymaniowy podejście. Diagramy można tworzyć na podstawie czytelnego kodu, przeglądać za pomocą podglądu wizualnego, wstawiać do odpowiedniego dokumentu i ponownie edytować, gdy zmieni się podstawowa informacja.
Tworzy to praktyczne fundamenty dla żywej dokumentacji. Diagram pozostaje użytecznym zasobem roboczym, a nie jednorazowym zrzutem ekranu.
Bardziej zintegrowany ekosystem Visual Paradigm
Visual Paradigm łączy różne produkty i funkcje, pomagając użytkownikom efektywniej przechodzić od pomysłów do modeli, diagramów, dokumentacji i wspólnej wiedzy.
VPasCode zapewnia doświadczenie diagramów jako kodu. OpenDocs zapewnia doświadczenie zarządzania dokumentami i wiedzą. Razem pomagają zespołom tworzyć treści wizualne i umieszczać je bezpośrednio w kontekście, w którym są potrzebne.
To połączenie może zmniejszyć konieczność przełączania się między narzędziami, uprościć proces tworzenia dokumentacji i pomóc zespołom w lepszym wykorzystywaniu diagramów przez cały cykl życia projektu.
Zacznij pracę z OpenDocs i VPasCode
Dzięki tej ulepszeniu Visual Paradigm OpenDocs staje się bardziej wszechstronnym środowiskiem do tworzenia strukturalnej, wizualnej i współpracującej dokumentacji. Użytkownicy mogą tworzyć diagramy za pomocą PlantUML, Mermaid, Graphviz, D2, Markmap, ECharts i innych obsługiwanych formatów, wstawiać je do stron i ponownie edytować, gdy wymagania się zmienią.
Jeśli szukasz online’owego generatora diagramów, platformy diagramów jako kodu, narzędzia do dokumentacji technicznej lub narzędzia do zarządzania wiedzą z zintegrowanymi możliwościami modelowania wizualnego, ten nowy przepływ pracy zapewnia wygodny sposób na połączenie diagramów i dokumentów.
Uruchom Visual Paradigm OpenDocsi zacznij tworzyć bogatszą, bardziej użyteczną dokumentację z edytowalnymi diagramami napędzanymi przez VPasCode.
Najczęściej zadawane pytania
Czym jest nowe ulepszenie OpenDocs?
OpenDocs umożliwia teraz użytkownikom tworzenie i wstawianie edytowalnych diagramów do stron dokumentów dzięki integracji z Visual Paradigm VPasCode.
Czy mogę edytować diagram po jego wstawieniu do OpenDocs?
Tak. Kliknij ikonę ołówka na wstawionym diagramie, aby ponownie otworzyć go w edytorze VPasCode. Po zmodyfikowaniu kodu diagramu kliknij Zapisz i Zamknij, aby odświeżyć diagram na stronie OpenDocs.
Jakie formaty diagramów są obsługiwane?
VPasCode obsługuje formaty i technologie, w tym PlantUML, Mermaid, Graphviz, D2, Markmap, ECharts, JSON, YAML, XML, CSV, TOML, DBML i SQL. Obsługiwane typy diagramów obejmują schematy blokowe, diagramy sekwencji, diagramy klas, diagramy stanów, diagramy ER, diagramy C4, mapy myśli, diagramy architektury, wykresy Gantta i inne.
Czy muszę znać kod diagramu, aby korzystać z tej funkcji?
Nie. Możesz załadować przykład z edytora VPasCode lub Galerii Przykładów. Możesz również użyć funkcji Twórz z AI, aby opisać żądany diagram w języku naturalnym i pozwolić AI wygenerować początkowy skrypt diagramu.
Gdzie mogę uzyskać dostęp do OpenDocs?
Możesz uzyskać dostęp do Visual Paradigm OpenDocs pod adresem https://ai-toolbox.visual-paradigm.com/app/opendocs/.
Gdzie mogę dowiedzieć się więcej o VPasCode?
Odwiedź Strona funkcji VPasCode aby dowiedzieć się więcej o platformie diagramów jako kodu, obsługiwanych formatach, renderowaniu w czasie rzeczywistym, pomocy AI i powiązanych funkcjach.