Opanowanie potoku OpenDocs: Wysyłanie artefaktów z Visual Paradigm Online do OpenDocs przez potok

Zrozumienie przepływu pracy potoku OpenDocs

Potok OpenDocs działa jako kanał dla zasobów wizualnych między Twoim środowiskiem projektowym a dokumentami tekstowymi. Zamiast zapisywać grafiki lokalnie i ręcznie osadzać statyczne pliki obrazów, potok tworzy bezpośrednie połączenie. Gdy pracujesz nad diagramami, wykresami lub projektami graficznymi, wysyłasz jawne zrzuty swojej pracy bezpośrednio do potoku repozytorium dokumentacji.

Wewnątrz Edytora OpenDocsautorzy mogą otworzyć panel Potoku, aby wyświetlić wszystkie opublikowane artefakty, sprawdzić historię wersji oraz wstawić dokładne wersje do swoich dokumentów. Ta architektura zapewnia autorom dokumentów pełną kontrolę nad tym, kiedy i w jaki sposób aktualizacje wizualne są włączane do opublikowanej treści.

Kluczowe funkcje i korzyści kontroli wersji

Integracja projektu wizualnego bezpośrednio w edytorze dokumentów przynosi kilka korzyści operacyjnych:

• Kontrolowane publikowanie artefaktów:Artefakty nie są wysyłane automatycznie przy każdej drobnej zmianie. W potoku pojawiają się tylko elementy, które jawnie wybierzesz do wysłania, co zapobiega zakłócaniu aktywnych dokumentów przez przypadkowe lub niekompletne aktualizacje.
• Kompleksowe śledzenie wersji:Potok przechowuje każdą wysłaną wersję Twojego artefaktu. Autorzy mogą wybrać między osadzeniem najnowszej wersji a przypięciem konkretnej historycznej wersji do swojego dokumentu.
• Wskaźniki aktualizacji wizualnych:Gdy diagram wstawiony do dokumentu otrzymuje aktualizację w środowisku pracy, panel Potoku OpenDocs wyświetla wyraźny wskaźnik wizualny. Pozwala to autorom przeglądać zmiany przed zaakceptowaniem aktualizacji.
• Zjednoczone zarządzanie treścią:Centralizuje diagramy architektury oprogramowania, wykresy danych i zasoby wizualne wewnątrz Visual Paradigmnarzędzi, utrzymując wysoką wierność wizualną i spójny formatowanie w całej dokumentacji przedsiębiorstwa.

Przewodnik krok po kroku: Wysyłanie i wstawianie artefaktów

Krok 1: Wyślij artefakty do potoku

1. Otwórz swój diagram, wykres lub projekt graficzny wewnątrz środowiska pracy.
2. W prawym górnym rogu kliknij Eksportuj i wybierz Wyślij do potoku OpenDocs. Alternatywnie kliknij przycisk „Wyślij do potoku OpenDocs umieszczony w menu bocznym.
3. W pojawiającym się oknie dialogowym możesz opcjonalnie wprowadzić opisowy komentarz rewizji, aby udokumentować swoje zmiany.
4. Kliknij „OK aby potwierdzić. Twój zrzut projektu został pomyślnie przesłany do potoku.

Krok 2: Wstaw artefakty do dokumentu OpenDocs

1. Otwórz swój dokument w edytorze.
2. Przejdź do górnego paska menu, kliknij „Wstaw„, a następnie wybierz „Potok.
3. . Przeglądaj dostępne artefakty wymienione w panelu potoku.
4. Kliknij żądany artefakt, aby wstawić jego bieżącą lub najnowszą rewizję bezpośrednio do treści dokumentu.
5. Jeśli wymagana jest konkretna wersja historyczna zamiast najnowszej kompilacji, kliknij „Ikona rewizji obok artefaktu i wybierz preferowaną wersję.

Krok 3: Aktualizuj artefakty dokumentu, gdy projekty ulegną zmianie

1. Gdy artefakt projektu zostanie zaktualizowany i ponownie wysłany do potoku, otwórz swój dokument i uruchom „Panel potoku.
2. Zlokalizuj artefakty wyświetlające wskaźnik aktualizacji.
3. Wybierz zaktualizowany artefakt, aby wyświetlić wszystkie dostępne rewizje.
4. Wybierz najnowszą rewizję, aby odświeżyć zasób wizualny w swoim dokumencie.

Praktyczne przypadki użycia

Przepływ pracy potoku OpenDocs zapewnia natychmiastową wartość dla wielu ról w przedsiębiorstwie:

• Specyfikacje architektury oprogramowania:Architekci systemów aktualizujący diagramy komponentów UML lub C4 mogą wysyłać zaktualizowane modele do potoku, co umożliwia technikom piszącym natychmiastową synchronizację dokumentacji API i architektury.
• Raportowanie biznesowe i projektowe:Analitycy biznesowi generujący wykresy danych wydajności za kwartał mogą wysyłać zaktualizowane wizualizacje do raportów dla zarządu bez naruszania istniejących układów dokumentów.
• Dokumentacja ścieżki produktu:Kierownicy produktów utrzymujący przewodniki po wydaniach mogą aktualizować szkice funkcji i upewnić się, że dokumentacja użytkownika skierowana do publiczności odzwierciedla aktualne projekty interfejsu użytkownika.

Wymagania dotyczące edycji

Funkcja OpenDocs Pipeline oraz system zarządzania wersjami są dostępne w wersji Combo Edition lub wyższej. Upewnij się, że Twój plan subskrypcji obejmuje te funkcje, aby w pełni wykorzystać ciągłą integrację dokumentacji.