Если вы хотите делать хорошую работу, вы должны сначала отточить свои инструменты.Здесь мы рекомендуем несколько отличных инструментов для создания документов с открытым исходным кодом для веб-разработчиков, надеясь помочь всем.
1. JavaScript
JSDoc 3
Это инструмент для создания документации API для приложений, библиотек и модулей JavaScript на основе информации о комментариях в файле JavaScript. Вы можете использовать его для записи таких вещей, как: пространства имен, классы, методы, параметры методов и т. д. Проект также породил множество шаблонов и других инструментов, помогающих создавать и настраивать документацию, например:
шаблон
инструменты для сборки
другие инструменты
ESDoc
Генератор документации JavaScript, который может генерировать удобную документацию по коду JavaScript путем написания комментариев к коду в соответствии со спецификацией. Он интегрирует тестовый код и руководства пользователя в документацию и поддерживает добавление пользовательских функций с помощью плагинов.
2. API
apiDoc
Это инструмент генерации документации RESTful Web API, небольшой инструмент для написания документации API в комментариях. С ним вам нужно всего лишь написать несколько простых комментариев при написании исходного кода, и вы сможете создавать красивые документы. Проект поддерживает большинство основных языков, а аннотации удобнее поддерживать, и нет необходимости вести дополнительный документ.
GraphQL Voyager
Это инструмент для представления произвольных API-интерфейсов GraphQL в виде интерактивных графиков, позволяющий интуитивно исследовать API-интерфейсы GraphQL. Полезно при разработке или обсуждении моделей данных.
3. Руководство по CSS/стилю
Таблицы стилей Knyle (KSS)
KSS — это и спецификация документа, и формат для написания руководств по стилю, призванный помочь разработчикам автоматизировать создание удобочитаемых и разборчивых руководств по стилю. Он предоставляет командам возможность писать поддерживаемый, документируемый CSS.
React Styleguidist
Как следует из названия, это генератор руководств по стилю React для обмена онлайн-руководствами по стилю с вашей командой. В нем перечислены типы поддержки компонентов и показаны живые редактируемые примеры использования на основе файлов Markdown.