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

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

Создавайте интерактивные технические диаграммы с помощью Draw.io

Пишите больше интересных технических статей Истории и картинки — это простые, но мощные инструменты, которые помогают человеческому мозгу полнее усваивать новые знания и дольше их запоминать. В контексте технического письма не было бы здорово использовать оба инструмента для создания глубоких пояснительных диаграмм, которые сообщали бы о сложных технических аспектах архитектуры программного обеспечения и бизнес-логики? Один из самых популярных графических инструментов — draw.io —..

Искусство создания идеального README: важнейший навык для начинающих программистов

Введение Путь к тому, чтобы стать успешным инженером-программистом, наполнен несколькими вехами и достижениями, которые включают в себя несколько факторов, таких как ознакомление с языками программирования, языковыми библиотеками, фреймворками и методологиями работы. Тем не менее, одним из наиболее недооцененных аспектов этого путешествия является искусство создания идеального файла README. Хорошо составленный README может сыграть решающую роль в демонстрации способностей человека,..

Как написать отличный README

Исчерпывающее руководство по написанию README, которое выделяется и заставляет людей восхищаться! Если вы торопитесь и просто хотите, чтобы шаблон был внизу ( не круто ). Остальные крутые люди готовятся сделать свой первый шаг к тому, чтобы стать README MASTER! (абсолютно не кликбейт). Вы только что создали этот потрясающий проект и поделились им на GitHub. Вы думаете, что теперь просто откинетесь и подождите, пока мир скажет вам, насколько крутой ваш проект. В конце концов,..

Как практиковать документацию начинающему специалисту по данным

Вспомните последний проект, над которым вы работали. Вы помните каждый свой шаг в этом проекте? От каждого шага обработки данных до внедренной вами техники машинного обучения? Теперь попробуйте вспомнить шаги из вашего проекта до этого. Вы помните все шаги там? Как насчет проекта до этого? Или за несколько месяцев до этого? Если вы не помните каждый шаг, это нормально (хотя, если бы вы могли, это впечатляет)! По мере того, как вы выполняете больше проектов, вы начинаете запоминать..

Как писать учебники, которые действительно учат

Почти каждый учебник - отстой. Мы можем лучше. «Дайте человеку рыбу, - говорим мы, - и накормите его в течение дня; научи человека ловить рыбу, и ты будешь кормить его на всю жизнь ». Эта пословица напоминает нам, что если мы хотим по-настоящему научить кого-то и сделать его самодостаточным, мы не должны просто давать им именно то, что им нужно. Вместо этого мы должны направлять их и следить за тем, чтобы они понимали, как делать то, чему мы их учим. Частично это включает в себя..

Написание читаемого кода: больше искусства данных, чем науки о данных

Вы когда-нибудь смотрели на чей-то код и чувствовали, что читаете по-гречески? Да, я тоже. Иногда этот код был моим собственным, спустя 3 месяца после того, как я оставил его в покое. Зачем нужна документация? Отсутствие документирования моего собственного кода уже было достаточно болезненным, когда мне пришлось вернуться и объяснить это другу несколько месяцев спустя. Я чувствовал себя дешифровальщиком, пытающимся проникнуть в свою голову и понять, что я делаю. Мне даже..

Пример использования: преобразование раздела для разработчиков Paytm в сеть разработчиков

Документирование, почему и как мы перешли к документации как концепции кода вместо тяжелого портала разработчиков, ориентированного на дизайн, для нашего продукта Payment Gateway. ПОЧЕМУ? Мы считаем, что есть разница между тем, как разработчики смотрят на вещи, и тем, как люди, не являющиеся разработчиками, смотрят на вещи. Ниже приведены наши наблюдения, которые в основном справедливы для любой продуктовой компании: На товарном портале есть одна область,..