Публикации по теме 'documentation'


Загадка Сфинкса: как легко документировать свой код
Почему я здесь? Вы, читатель, пришли сюда потому, что написали на Python какой-то замечательный инструмент и хотите сделать его доступным и простым в использовании. Я, писатель, здесь, потому что несколько месяцев назад был как раз там, где находитесь вы. Я хотел использовать пакет Sphinx для создания документации в стиле ReadTheDocs для моего проекта. Я нашел внедрение Sphinx нетривиальным, поэтому я сделал репозиторий GitHub , который можно использовать в качестве шаблона для..
Документация для разработчиков
Разработчики не любят писать документы, какая альтернатива? Я не часто провожу время на Reddit, в основном потому, что это отправляет вас в интернет-червоточину. Вы нажимаете на одну ссылку и вдруг понимаете, что потеряли полдня, крича на людей неправильно в Интернете . Однако я снисходительно отношусь к тому, чтобы читать r/ProgrammingHumor, и именно тогда я увидел это в начале недели . Как бы вы ни старались, может быть трудно направить пользователей по правильному пути. Я..
Одна неожиданная полезная привычка кодирования, которую я усвоил из плагинов Airflow
Я всегда слышал, что один из лучших способов стать разработчиком — больше читать код. В частности, идея состоит в том, что вы должны читать код, написанный лучшими, более опытными разработчиками. Это всегда имело для меня смысл в теории, но я никогда не применяла эту теорию на практике. Я просто не работал над проектами, в которых документация отдавала предпочтение созданию дополнительных функций. Я собирал достаточно кода Python, чтобы заставить что-то работать, а затем сразу же..
Использование узловых модулей для предоставления офлайн-документации
Использование узловых модулей для предоставления офлайн-документации Представляем Module Docs , пакет Node, который обслуживает файлы README из каталога node_modules ваших приложений. Сервер документации модуля - CodeSandbox CodeSandbox - это онлайн-редактор, специально предназначенный для веб-приложений. codesandbox.io Вы молодой, модный и активный разработчик? Я тоже, но я, как правило, занимаюсь разработкой приложений в..
Sphinx, инструмент документирования кода
Безболезненный способ внести свой вклад в лечение плохой документации Вы только что закончили свой последний шедевр разработки. Теперь вам нужно вернуться и задокументировать это или найти кого-то, кто любит писать гораздо больше, чем вы, чтобы выполнять эту работу. Каковы шансы, что ваша документация будет, не говоря уже о том, что она будет хорошей? Фигово? Пытались ли вы научиться использовать библиотеку кода или вам приходилось поддерживать чужой код и проклинать отсутствие..
Написание документации для непрограммистов
Я трачу много времени на написание кода для таких вещей, как моды для видеоигр, Photoshop и API-интерфейсы веб-сайтов, которые, скорее всего, будут использовать непрограммисты. Поэтому я часто обнаруживаю, что выражаю колебания, прежде чем я буду готов развернуть сценарии и ботов, пока моя документация не станет достаточно надежной, чтобы ее мог понять любой читающий. Действительно идти шаг за шагом Вникайте в мельчайшие детали того, как запускать вашу программу, и рассматривайте каждый..
Улучшите свой JavaScript с помощью магии документации 📖 💫
Почему и как нужно документировать модульный JavaScript! В прошлом посте я говорил о том, почему мы должны модулировать наш JavaScript : Следующий шаг на пути к JavaScript Самая универсальная истина, которую я могу придумать:« Мы все хотим меньше сосать . medium.com» В этом посте мы действительно запачкаем руки! Почему мы должны документировать 📝 Когда мы пишем модульный JavaScript и начинаем перемещать функции в отдельные..