Просмотреть документацию

Перейти к полной версии на китайском

Что такое ShowDoc?

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

Где же документация?! Где же документация?! Покажите мне документацию!!

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

Общими чертами являются различные документы Word, рассредоточенные между различными членами команды.

Как получить последнюю версию документации? Вот один способ.

Человек получает документацию, крича, ха-ха. Затем он получает её от других через мгновенные сообщения или электронную почту. Такой вид коммуникации не так плох, но это не самый эффективный метод.

Итак, какой же самый эффективный метод? ShowDoc приходит на помощь!

ShowDoc — это инструмент, который очень удобен для использования IT-командой для онлайн-поддержки документов. Он повышает эффективность коммуникаций между членами команды.### Для чего его можно использовать?

• Документация API (Демо)

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

• Справочник данных (Демо)

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

• Объяснительная документация (Демо)

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

Какие функции имеются сейчас?

• Поделиться и экспортировать

Ответственный дизайн веб-страниц позволяет делиться проектными документами для чтения на компьютерах или мобильных устройствах. Также можно экспортировать проект в локальный документ Word.

• Управление правами доступа

  • Открытые и закрытые проекты

    Проекты в ShowDoc разделены на две категории — открытые проекты и закрытые проекты. К открытому проекту может получить доступ любой пользователь, а к закрытому требуется авторизация. Пароль устанавливается владельцем проекта. - Передача проекта

    Владелец проекта может свободно передать его другим пользователям.

  • Участники проекта

    Вы можете легко добавлять или удалять участников проекта. Участники могут редактировать документы, но они не имеют права передавать или удалять проект; это право имеет только владелец.

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

  • Поддержка Markdown

    ShowDoc использует редактор Markdown, который отличается удобством как при редактировании, так и при чтении. Если вы ничего не знаете о Markdown, воспользуйтесь поиском с ключевыми словами "учебник и введение в Markdown".

  • Вставка шаблонов

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

  • Версионность

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

Развертывание на вашем сервере

• Развертывание ShowDoc

  Для получения информации обратитесь к: AutoInstall.md

• Развитие и вклад

  Для получения информации обратитесь к: Development&Contribution.md### О правах использования

ShowDoc распространяется в соответствии с лицензией Apache2 Open Source License и является бесплатной программой. Showdoc имеет дополнительное уведомление о правах использования, которое следует условиям лицензии Apache2 Open Source License:

Официальный сайт Showdoc и автор star7th обладают авторским правом и соответствующими правами на программу при условии сохранения информации об авторском праве и ссылок на пользовательском интерфейсе программы. Она может использоваться бесплатно или для вторичного развития. Если вам необходимо изменить информацию об авторском праве или ссылки на него, вам потребуется официальное согласие и разрешение.