Publikowanie dokumentacji produktu za pomocą Docsie

Avatar of Author
Tal F.
on June 30, 2021 · · filed under Product Documentation AI Product Management Documentation Portals Technical Writing

Cześć wszystkim!

W moim ostatnim filmie mówiłem o tym, jak tworzyć dokumentację produktu i edytować dokumentację produktu. Pokazałem również, jak osadzać filmy, zdjęcia, multimedia, a także kod, abyś mógł tworzyć dokumentację produktu, abyś mógł dalej edukować swoich klientów na temat swoich platform technicznych i rozwiązań.

Teraz chciałem zagłębić się w platformę dokumentacji produktów Docsie i pokazać, jak w prosty i łatwy sposób tworzyć dokumentację oprogramowania.

Oto krótki samouczek wyjaśniający, jak publikować za pomocą Docsie.

Publikowanie za pomocą portalu wiedzy Docsie może odbywać się na kilka sposobów. W tym filmie wyjaśniam, jak publikować za pomocą portali wiedzy Docsie, książek, półek lub artykułów za pomocą jednej prostej linii kodu.

W tym przykładzie chciałem opublikować tę konkretną książkę zatytułowaną "Pisanie pierwszej aplikacji Django, część 2

Jak widać w mojej aktualnej, już utworzonej dokumentacji oprogramowania, napisałem wersję o nazwie "Zupełnie nowy portal, nad którym pracuję", a jeśli klikniesz narzędzie "ołówek" obok niego, masz możliwość uczynienia opublikowanego portalu "aktywnym" lub "głównym" lub wyłączenia tych funkcji. co jest niesamowite, ponieważ oznacza to, że Ty i Twój zespół możecie pisać lub aktualizować dokumentację i nie mieć jej widocznej dla klientów lub klientów, dopóki nie będziesz gotowy do opublikowania utworzonej dokumentacji produktu w produkcji na swojej stronie internetowej:

Jeśli jesteś gotowy do publikacji, nadszedł czas, aby wdrożyć swoją dokumentację! Można to łatwo zrobić, klikając na trzy kropki w prawym górnym rogu platformy Docsie, a następnie klikając na swoje konto:

Gdy znajdziesz się na stronie swojego profilu i ustawień, kliknij zakładkę zatytułowaną "Wdrożenia". Spowoduje to przejście do strony wdrażania i pomoże Ci skonfigurować tworzenie kodu osadzania, który zostanie umieszczony w Twojej witrynie.

Teraz kliknij "Skonfiguruj nowe wdrożenie +"

Świetnie! Teraz, gdy masz dostęp do pulpitu nawigacyjnego, wszystko, co musisz zrobić, to wdrożyć niestandardową domenę, co można łatwo zrobić, otwierając pasek zakładki "Wdróż domenę:" i klikając "niestandardowe wdrożenie".

Teraz kolejne dwa kroki są proste:

  1. Pierwszym krokiem jest wpisanie domeny (i pamiętaj, aby użyć http:// lub https:// przed wpisaniem nazwy domeny)

  2. drugim krokiem jest wybranie tego, co chcesz opublikować, masz do wyboru publikację książki lub całej półki. W tym przykładzie publikuję książkę o tytule: "Pisanie pierwszej aplikacji Django, część 2".

Świetnie! Teraz ostatnim krokiem przed pobraniem naszego kodu jest kliknięcie "+More Options".

Teraz możesz korzystać z naszych różnych wtyczek, funkcji i innych opcji dokumentacji, aby urozmaicić swój portal wiedzy i uczynić go bardziej poręcznym dla użytkowników. Te funkcje, wtyczki i narzędzia do dokumentacji produktów są całkiem przydatne i sprawiają, że portale wiedzy są bardziej niezawodne.

Uwaga: te dodatkowe funkcje i wtyczki oraz inne narzędzia dokumentacji produktu można zmienić w dowolnym momencie.

Po zakończeniu kliknij "Utwórz portal internetowy".

Teraz przewiń w dół do samego dołu i kliknij "+ Get deployment script".

Następnie skopiuj skrypt i wklej go do kodu HTML:

Teraz, gdy masz już dostęp do swojego skryptu, możesz urozmaicić go za pomocą naszego przewodnika użytkownika CSS, który pomoże Ci stworzyć stylowy portal wiedzy Docsie, który będzie pasował do wyglądu i stylu Twojej marki. Zapoznaj się z naszym przewodnikiem użytkownika dotyczącym stylizacji pod tym linkiem: Przewodnik stylizacji Docsie

Mam nadzieję, że spodobał ci się ten poradnik, bądź na bieżąco z kolejnymi poradnikami Docsie w najbliższej przyszłości!

Jeśli masz jakieś pytania dotyczące tego, jak Docsie może pomóc i chcesz, abyśmy pokazali Ci demo naszych narzędzi, prosimy o Kliknij tutaj, aby zarezerwować u nas demo.


Subscribe to the newsletter

Stay up to date with our latest news and products