Онлайн-инструмент для обмена документами showdoc v3.2.6

ShowDoc — это онлайн-инструмент для документирования API и технической документации, который очень подходит для ИТ-команд. С помощью showdoc вы можете легко использовать синтаксис уценки для написания красивых документов API, документов словаря данных, технических документов, онлайн-документов Excel и т. д. Если вы не хотите редактировать документы с уценкой, вы также можете использовать возможности автоматизации showdoc для автоматического создания документов API из комментариев к программе или автоматического создания документов во время отладки интерфейса с помощью соответствующего клиента RunApi (инструмент отладки API, аналогичный почтальону). Назначая участников проекта и членов команды, вы можете легко управлять разрешениями для документов проекта и совместной работой в команде, а также можете делиться документами с друзьями для просмотра. ShowDoc также поддерживает многоплатформенные клиенты, включая клиент Win, клиент Mac, iOS, Android и т. д., что делает его более удобным для кроссплатформенного использования. В настоящее время более 100 000 интернет-команд используют showdoc, в том числе некоторые команды известных компаний, таких как Tencent, Huawei, Baidu, JD.com, ByteDance, SF Express и т. д.

для чего его можно использовать

1. Документация API

С развитием мобильного Интернета BaaS (бэкенд как услуга) становится все более популярным. Сервер предоставляет API, а приложение или веб-интерфейс могут легко вызывать данные. С помощью ShowDoc можно очень удобно и быстро писать красивые API-документы.

2. Словарь данных

Хороший словарь данных может легко объяснить другим структуру вашей базы данных, например определение каждого поля и т. д.

3. Документация

Вы можете использовать showdoc для написания инструкций для некоторых инструментов, а также можете написать некоторые документы с техническими спецификациями для рассмотрения командой.

Какие функции у него есть

1. Делитесь и экспортируйте

Адаптивный веб-дизайн, документы проекта можно передавать на компьютеры или мобильные устройства для просмотра. В то же время вы также можете экспортировать проект в текстовый файл для просмотра в автономном режиме.

2. Управление разрешениями

(1), государственные проекты и частные проекты

На ShowDoc есть два типа проектов: публичные проекты и частные проекты. Доступ к общедоступным проектам может получить любой вошедший или не вошедший в систему пользователь, тогда как частным проектам требуется пароль для аутентификации доступа. Пароль задается создателем проекта.

(2) Передача проекта

Создатели проектов могут свободно передавать проекты другим пользователям сайта.

(3), участники проекта

Вы можете легко добавлять и удалять участников проекта в проектах ShowDoc. Участники проекта могут редактировать проект, но не могут переносить или удалять проект (право есть только у создателя проекта).

(4), управление командой

Вы можете лучше сотрудничать со своей командой, используя функцию команды showdoc.

3. Функция редактирования

(1), редактирование уценки

ShowDoc использует редактор уценок, который обеспечивает превосходные возможности редактирования и чтения. Если вы не знаете Markdown, найдите «Понимание и начало работы с Markdown» в поисковой системе.

(2) Вставка шаблона

На странице редактирования ShowDoc нажмите кнопку над редактором, чтобы легко вставлять шаблоны интерфейса API и шаблоны словаря данных. После вставки шаблона остается только изменить данные, что позволяет сэкономить массу усилий на редактировании.

(3), история

ShowDoc предоставляет функцию истории страницы, и вы можете легко восстановить предыдущую страницу.

4. Мультиплатформенность

showdoc поддерживает версию мобильного приложения и версию компьютерного клиента.

5. Автоматизация

(1) Документы могут автоматически генерироваться из комментариев к коду.

(2), оснащен клиентом RunApi, интерфейсом отладки и автоматическим созданием документов.