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


Почему не следует использовать Confluence для документации по коду
КОДЕКС Почему не следует использовать Confluence для документации по коду Это всегда устарело Большинство из нас были там - это почти обряд посвящения: следование руководству в Confluence, которое ужасно устарело. Человек, который его написал, очень гордился деталями во время создания, добавил много скриншотов и, возможно, даже несколько анимированных изображений. К сожалению, панель меню на снимке экрана больше не существует, а кнопка, необходимая для выполнения одного из..
Документы, подвергшиеся критике
Я достаточно взрослый, чтобы помнить, когда Agile был еще новичком в разработке программного обеспечения, по крайней мере, до того, как он стал более или менее де-факто. Один из принципов Манифеста - Рабочее программное обеспечение важнее исчерпывающей документации . Я согласен с этим принципом как указано и многим из того, что вы должны из него извлечь. Но я встречал множество людей, которые, кажется, думают, что это означает «БЕЗ ДОКУМЕНТАЦИИ. EVAR. » Или что-то, может быть,..
Важность хорошей документации
Все мы знаем, что документация является важной частью любого программного обеспечения. Будь то самодокументирующийся код или документация, размещенная на специальных веб-сайтах. В конце концов, все, что имеет значение, — это качество документации. Я занимаюсь разработкой программного обеспечения большую часть своей жизни, поэтому изучение документации, руководств, руководств и т. д. стало частью большей части моей жизни. На протяжении многих лет я имел дело со всем: от полностью..
Кукловод предназначен не только для тестирования! Как создавать отличные документы и упростить разработку
Вы когда-нибудь слышали о Кукольнике ? Инструмент, позволяющий программно управлять браузерами на базе Google Chrome и Chromium. Двумя основными способами использования кукольника являются двухстороннее тестирование и очистка сайта, но вы можете сделать гораздо больше с его помощью, и эта статья посвящена двум другим возможным применениям. Создание документации Создание документации может быть утомительной работой. Обычно требуется делать снимки экрана приложения на определенных..
5 шагов к написанию следующей технической статьи
За последние несколько месяцев я написал немало технических статей ( здесь ). Поначалу казалось неестественным применять то, что я выучил на уроках английского, к холодной логике программирования и компьютеров. Несмотря на это, я промыл и повторил достаточное количество раз, чтобы убедиться, что это не так уж и плохо. Ниже я описываю пять шагов, которые я предпринимаю в той или иной форме каждый раз, когда пишу техническую статью. 1. Исследуйте и делайте заметки (делайте дело)..
Три способа публикации документации Sphinx
Интеграция с GitHub Actions и автоматическая публикация В предыдущей статье мы обсуждали, как быстро генерировать документацию с помощью инструментов Sphinx CLI. В этой статье я продемонстрирую три различных способа публикации документации Sphinx. Следовательно, любой, у кого есть URL-адрес, может просматривать вашу документацию. Я также интегрирую процессы публикации в GitHub Actions, чтобы они были полностью автоматизированы. Опубликовать на страницах GitHub GitHub Pages —..
Состояние документации SwiftUI
В последнее время я экспериментировал со SwiftUI, в частности, писал небольшие программы для macOS, чтобы понять, как работает SwiftUI и сам Swift. Как профессиональный компьютерный инженер, я немного разочарован состоянием доступной документации Apple. Чтобы быть честным с Apple, они предоставляют некоторую документацию — например, презентационные видео WWDC могут быть очень полезными. Однако я обнаружил, что материал в видео довольно плотный и требует довольно много контекста, чтобы..