Публикации по теме 'documentation'
Создайте простой интерфейс для своего приложения машинного обучения с помощью Flasgger.
Допустим, вы собрали данные, выполнили проектирование функций и построили модель для своего крутого стороннего проекта. Когда дело доходит до обмена моделью с друзьями и сообществом, вы предоставляете модель как API. Без четкой документации и пользовательского интерфейса пользователи, вероятно, были бы озадачены функциональностью и параметрами API. Мы можем использовать Flasgger для решения этой конкретной проблемы.
В этой статье мы создадим 2 API машинного обучения с Flask в качестве..
Документация — Чего еще не хватает в документации вашего проекта (взгляд фронтенд-разработчика)
В мире фронтенда мы часто работаем над внутренними проектами или продуктами, где документация либо отсутствует, либо не содержит важной информации. Это знакомый сценарий, который может снизить производительность и вызвать разочарование. Даже если документация существует, непрерывное написание документации в режиме реального времени может оказаться сложной задачей для команд. Он легко может устареть, так как зачастую непонятно, когда и как его обновлять.
Однако когда мы решаемся заняться..
3 документальных ужастика и как их избежать
Уроки, извлеченные из неправильной документации
Как специалисты по данным, мы все слышали (если не испытали) ужасные истории о документации — что может пойти не так, если мы не потратим время на тщательное документирование наших моделей. В рамках моей работы по улучшению процессов документирования в моей компании Verta я собрал (и анонимизировал) «зал позора» для историй, в которых освещаются решения, позволяющие избежать ошибок, связанных с плохой документацией.
Страшная история №1..
Документирование вашей библиотеки Python, от нуля до веб-сайта
Документация - это настоящий проект, но ваш проект уже является проектом, а кому нужен другой проект?
Мы начнем с совершенно пустого проекта и перейдем к веб-сайту, размещенному на страницах GitHub, который создается автоматически с помощью действий GitHub.
Здесь вы можете увидеть окончательный результат .
Вы можете найти весь код этого проекта на GitHub здесь .
Ваша библиотека
Я сказал, что мы сделаем это с нуля, поэтому нам придется сделать библиотеку. У вас, вероятно,..
Сегодняшний лакомый кусочек: документальное тестирование Эликсира
Так что это круто. Эликсир позволяет вам определить простой тестовый модуль следующим образом:
defmodule DocTest do
use ExUnit.Case, async: true
doctest Unicorns
end
Это круто и делает вещи! Но что именно он делает? Он запускает примеры кода в комментариях к документации. (Если вы пользователь Python, приносим извинения за резкость.)
да. Вы правильно прочитали. Автоматизированное тестирование примеров документации! Давайте посмотрим на пример:
defmodule Unicorns do
@doc..
8 лучших инструментов для создания внутренней документации
Что такое хорошая внутренняя документация? И почему важно иметь правильный инструмент внутренней документации для ваших команд разработчиков?
Внутренняя документация — это база знаний организации — она предоставляет информацию о различных аспектах инженерных процессов, систем, инструментов, лучших практик или информации, связанной с проектом.
Для инженерных групп создание хорошей внутренней документации сильно отличается от создания общедоступных документов. Вы удовлетворяете не..
Документация 📝 как код: понимание проблемы
Если вы ответите НЕТ на приведенные ниже вопросы, возможно, этот и другие посты в этой серии помогут вам лучше писать документацию и управлять ею 📝.
ДОВЕРЯЕТЕ ли вы своей текущей документации? Существует ли только один единственный источник правды для вашей документации? Легко ли найти? Легко ли построить граф зависимостей из текущей документации? Всегда ли он синхронизирован с функциями вашей кодовой базы? Легко ли понять журналы изменений или выпусков?
Очень важно..
