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

Ниже приведены некоторые распространенные структуры документации интерфейсного пользовательского интерфейса:

docsify

Docsify — это генератор документации на основе JavaScript, который помогает быстро создавать красивые и адаптивные веб-сайты с документацией.

https://docsify.js.org/#/

#Storybook

Storybook: Storybook — это инструмент для разработки, тестирования и демонстрации повторно используемых компонентов. Он предоставляет интерактивный интерфейс, который может отображать и запускать отдельные компоненты, а также позволяет разработчикам писать документацию по компонентам. Storybook поддерживает несколько интерфейсных платформ, таких как React, Vue и Angular.

https://storybook.js.org/

#Styleguidist

Styleguidist — это генератор документации компонентов React, который автоматически генерирует документацию компонентов и показывает примеры и использование каждого компонента. Styleguidist также поддерживает такие функции, как автоматическое создание руководства по стилю, поддержка синтаксиса Markdown и обновления в реальном времени.

https://react-styleguidist.js.org/

#Docz

Docz — это генератор документации компонентов React, который предоставляет простой в использовании интерфейс и настраиваемые параметры конфигурации. Docz может создавать документацию на основе аннотаций компонентов и кода JSX и поддерживает Markdown, MDX и пользовательские темы.

https://www.docz.site/

#Docusaurus

Docusaurus — инструмент для создания, поддержки и развертывания статических веб-сайтов. Он подходит для создания документов проекта, командных документов и документов любого другого типа. Docusaurus объединяет Markdown, React и некоторые пользовательские параметры конфигурации, чтобы помочь разработчикам быстро создавать красивые веб-сайты с документацией.

https://docusaurus.io/

#vitepress

Можно сказать, что это обновленная версия vuepress.

Vite & Vue Powered Static Site Generator Simple, powerful, and fast. Meet the modern SSG framework you've always wanted.

https://vitepress.dev/

#VuePress

VuePress — это генератор статических веб-сайтов на основе Vue.js, который можно использовать для создания простых и настраиваемых веб-сайтов с документацией. Он поддерживает компоненты Markdown и Vue и предоставляет такие функции, как автоматически создаваемая навигация, боковые панели и возможности поиска.

https://vuepress.vuejs.org/

#idoc

idoc — быстрый, лаконичный и эффективный инструмент для создания документов. idoc использует Markdown для анализа статей и создания статических веб-страниц с использованием темы по умолчанию за несколько секунд.

https://wangchujiang.com/idoc

#Обычно используется в бэкэнде

swagger

https://swagger.io/

apifox

https://apifox.com/

apipost

https://www.apipost.cn/

postman

https://www.postman.com/

knife4j

https://doc.xiaominfo.com/