.
Всем привет!
В своем последнем видео я рассказывал о том, как создавать документацию по продукту и редактировать документацию по продукту. Также я показал вам, как вставлять видео, изображения, медиа, а также код, чтобы вы могли создавать документацию по продуктам для дальнейшего обучения ваших клиентов о ваших технических платформах и решениях.
Теперь я хотел бы углубиться в платформу документации по продуктам Docsie и показать вам, как просто и легко создавать документацию по программному обеспечению.
Вот краткое руководство, объясняющее, как публиковать документы с помощью Docsie.
Публикация с помощью портала знаний Docsie может быть осуществлена несколькими способами. В этом видео я объясняю, как опубликовать с помощью портала знаний Docsie книги, полки или статьи с помощью одной простой строки кода.
В данном примере я хотел опубликовать конкретную книгу под названием 'Writing your first Django app, part 2'.
Как вы можете видеть, в моей текущей уже созданной документации по программному обеспечению я написал версию под названием "Совершенно новый портал, над которым я работаю", и если вы нажмете на инструмент "карандаш" рядом с ним, у вас будет возможность сделать опубликованный портал "активным" или "основным" или отключить эти функции. Это замечательно, потому что это означает, что вы и ваша команда можете писать или обновлять документацию и не показывать ее вашим клиентам или заказчикам, пока вы не будете готовы опубликовать созданную документацию по продукту в производстве на вашем сайте:
Теперь, когда вы готовы к публикации, пришло время развернуть вашу документацию! Это легко сделать, сначала нажав на три точки в правом верхнем углу платформы Docsie, а затем кликнув на свой аккаунт:
Как только вы окажетесь на странице профиля и настроек, нажмите на вкладку "Развертывания". Это приведет вас на страницу развертывания и поможет вам создать код встраивания, который будет размещен на вашем сайте.
![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_FOdT3hJo8ygjq6lYH/boo_IPAeUSAJvs2JsOCoT/ed142930-2a7b-b56c-0ccf-3183c6191179image.png)
Теперь нажмите "Configure a new deployment +".
Отлично! Теперь, когда у вас есть доступ к приборной панели, все, что вам нужно сделать, это развернуть пользовательский домен. Это легко сделать, открыв панель вкладок "Развертывание домена:" и нажав "пользовательское развертывание".
![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_Xlx7uCVpKiy3TJbaI/boo_IPAeUSAJvs2JsOCoT/30f5281a-702a-9bd4-a926-9440f1aaef22image.png)
Теперь следующие два шага просты:
-
Первый шаг - ввести свой домен (и не забудьте использовать http:// или https:// перед написанием доменного имени).
-
Второй шаг - выбрать, что вы хотите опубликовать, у вас есть выбор: опубликовать книгу или целую полку. В данном примере я публикую книгу под названием: "Написание вашего первого приложения Django, часть 2".
Отлично! Теперь последний шаг перед получением нашего кода - нажать "+More Options".
Теперь вы можете использовать наши различные плагины, функции и другие возможности документирования, чтобы украсить ваш портал знаний и сделать его более удобным для ваших пользователей. Эти функции, плагины и средства документирования продуктов довольно удобны и делают ваши порталы знаний более надежными.
![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_Wy76iK9zPT84NoPdu/boo_IPAeUSAJvs2JsOCoT/ed41417e-41dc-cffc-161a-4ffa182d3796image.png)
примечание: вы можете в любое время изменить эти дополнительные функции и плагины, а также другие средства документирования продукта.
После этого нажмите кнопку 'Создать веб-портал'.
Теперь прокрутите страницу вниз и нажмите "+ Получить сценарий развертывания".
![] (https://cdn.docsie.io/workspace_WxPJSQ5gsES8Bzjxy/doc_ydgtE07E6Rp4AMmKv/file_Lv7JtNkP26EPzxBTw/boo_IPAeUSAJvs2JsOCoT/6196219b-ddb3-55b8-d15f-3b08276ebbc2image.png)
Скопируйте ваш скрипт и вставьте его в HTML:
Теперь, когда у вас есть доступ к вашему скрипту, вы можете придать ему пикантности с помощью нашего руководства по CSS, которое поможет вам создать стильный портал знаний Docsie, соответствующий внешнему виду и атмосфере вашего бренда. Пожалуйста, ознакомьтесь с нашим руководством по стилизации по этой ссылке: Docsie's styling Guide
Надеюсь, вам понравилось это руководство, следите за дальнейшими уроками по Docsie в ближайшем будущем!
Если у вас есть вопросы о том, как Docsie может помочь, и вы хотите, чтобы мы показали вам демо-версию наших инструментов, пожалуйста, не стесняйтесь Click Here, чтобы заказать у нас демонстрацию.