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


Возможно, Полное руководство по технической документации.
Примечание. Начинаю писать статьи, поэтому будем признательны за любые отзывы. Введение Управление технической документацией — это Haaaard. Все будут его писать, но никто не будет его поддерживать . Confluence, Readme, Gitbook, Read the Docs и т. д. и т. д. служат прекрасной цели, однако, если вам действительно нужна самая последняя документация для ваших систем и отделов, давайте начнем прямо сейчас! › Если у вас нет времени читать, то вы можете просмотреть результаты [ здесь ]..
Как кодировать с эмпатией?
Это означает именно то, что он говорит. Я проснулась сегодня с кучей ерунды в голове и понятия не имею, как провести выходные. В этом нет ничего необычного, потому что я не из тех людей, которые планируют весь свой день; вместо этого я предпочитаю импровизировать большую часть своего свободного времени, которое обычно состоит из того, что я провожу свой день с хорошей едой, горячим шоколадом и Netflix. Но сегодня мне не хотелось делать ничего подобного, поэтому я решил вместо этого..
Типы технической документации и ее значение
Что можно, а что нельзя и почему это недооценивают. Существует много видов документации в зависимости от потребителей. Документирование является жизненно важной частью разработки программного обеспечения, но мы документируем для других заинтересованных сторон и чаще всего забываем о себе (разработчиках). Некоторые преимущества технической документации включают в себя: Это помогает при адаптации новых инженеров. Недавно мы наняли стажера, и я могу себе представить, как тяжело было..
Написание более чистого кода — ошибка
Некоторые программисты считают, что код должен говорить сам за себя. Эти программисты приводят разные причины, по которым они не документируют свой код. Однако эти причины часто связаны с логическими ошибками и когнитивным диссонансом. Вот почему совет «писать более чистый код» является заблуждением. Люди не машины Эволюция языков программирования рассказывает о том, как языки программирования используются в качестве интерфейсов для людей, позволяющих эффективно писать машинный..
Написание документов
Написание документов Выход за рамки README Итак, вы - я, и вы - разработчик программного обеспечения, и перед вами стоит конечная задача - наконец-то приступить к написанию документации. Вы помните время, когда вы думали, что документировать вещи не так уж важно, если вы хорошо пишете компьютерные программы. Вы бы приукрашивали свои крошечные функции и гордились бы тем, что всегда пишете читаемый код (как вы и предполагали), продумываете имена переменных и думаете, что ни у кого не..
Как написать хорошую документацию по коду для специалистов по данным
Ускоренный курс по передовым методам, необходимым для того, чтобы все понимали код, который вы пишете. Специалист по данным, пишущий хорошую документацию по коду, во многом похож на инженера, который следит за тем, чтобы опоры, поддерживающие мост, могли выдержать вес самого моста и пассажиров, которые им пользуются. Документация по коду не только дает представление о том, что делает код, но также дает другим людям представление о мыслительном процессе программиста и о том, почему код..
Документация Wunderlist API на GitHub
Когда мы опубликовали нашу документацию по Wunderlist API в начале этого года, нам нужно было простое и легкое решение, позволяющее разработчикам задавать вопросы или сообщать о проблемах. Первой нашей мыслью было переполнение стека. Это замечательный ресурс для разработчиков, и они побуждают компании участвовать в ответах на вопросы. Однако - кстати, вполне понятно - они не хотят быть основным каналом поддержки компаний. Мы вкратце рассмотрели возможность создания собственного..