Краткий разбор типичных ошибок и когнитивных искажений при написании технической документации для разработчиков. Обнаружение и hotfix этих дефектов призван сделать ваши тексты лучше, а процесс работы с ними — чуть более осознанным.
Бывший проектировщик / Технический писатель?
28 расширений VS Code для разработки документации
Плагины VS Code, без которых техническим писателям и разработчикам документации жить можно, но сложно. В подборке — линтеры, форматирование, работа с git, проектирование API, подготовка схем и милота для удобной разработки.
РЕД ОС: первые впечатления от импортозамещенной операционки
Разработчики РЕД ОС избавились от одной болезни Linux, но ничего не смогли сделать с другой...
Как прогресс ухудшил жизнь продвинутых пользователей (и как это исправить)
Я не люблю нытьё «раньше трава была зеленее» и в целом рад техническому прогрессу. Но считаю, что вместе с развитием компьютеров произошли и некоторые перемены, которые ухудшили жизнь «продвинутых пользователей» (power users) в угоду массовому пользователю. Перемены, которые мешают людям использовать технологии максимально эффективно.
Думаю, что на Хабре много людей, которых эта проблема затрагивает. А ещё думаю, что ситуацию возможно хотя бы немного изменить к лучшему. Поэтому решил рассказать, в чём вижу проблему и путь её частичного исправления.
Что-то в тексте может показаться спорным, поэтому хочу уточнить: хотя этот пост размещён в блоге компании, мнение только моё личное.
Вхождение в IT: через тернии к звездам
Всем привет! Я новичок на Хабре в части публикаций, поэтому прошу сразу не пинать.
Хочу начать со знакомства и сперва поделиться своим опытом вхождения в IT. Он был долгим. Извилистым. Порой я с него сворачивал, но все дороги известно куда ведут.
15 своих «лучших» лет я отдал МВД России. Служил на благо Родине, но стало так тошно, что уже невмоготу...
Лямбда-функция в Python простыми словами
В этой статье вы подробнее изучите анонимные функции, так же называемые "лямбда-функции". Давайте разберемся, что это такое, каков их синтаксис и как их использовать ( с примерами).
Лямбда-функции в Python являются анонимными. Это означает, что функция безымянна. Как известно, ключевое слов def
используется в Python для определения обычной функции. В свою очередь, ключевое слово lambda
используется для определения анонимной функции.
Пришло время программистов-самоучек
И почему к нам стоит присоединиться
Миф
Среди комментариев к одному из постов с рекламой моей книги «The Self-Taught Programmer» («Computer Science для программиста-самоучки. Все что нужно знать о структурах данных и алгоритмах») был и такой: «Хочу научиться программировать, но слышал, что в компаниях не воспринимают всерьез программистов без академической степени». К сожалению, это распространенное убеждение, и к счастью – неверное.
История успеха ZX Spectrum и культовые игры для него
16 сентября 2021 года скончался сэр Клайв Синклер, создатель ZX Spectrum. Недавно я пролистывал подборку статей на Хабре и наткнулся на пост про годовщину его смерти. И вдруг вспомнил, как в далекой юности мы с отцом и братом резались в Boulder Dash, Dizzy и Elite на «Синклере», как его называли в народе. Кажется, шел 1994 год.
Так уж совпало, что в тот же день, как увидел новости, я играл на PS4 в игру Sekiro: Shadows Die Twice. К слову, это довольно сложновато — отдельный привет разработчику игры Миядзаки. И когда мне в очередной раз всыпали треклятые самураи, я в ярости разбил джойстик об стол. В тот момент я снова вспомнил отца, когда он на последнем уровне сложности пытался схватить человечком последний кристалл в Boulder Dash, но немного не успевал. И точно так же разнес самодельную клавиатуру вдребезги. Яблоко от яблони, как говорится…
Все эти эмоции наслоились в голове, и я поймал себя на мысли — какие же клевые были игры. Да, графики не было от слова совсем. Но логики, «играбельности» и просто какого-то шарма было даже больше, как я вспоминаю. И я твердо решил: хочу рассказать на Хабре про Клайва Синклера, его жизнь и про то, какие же клевые игры были на ZX Spectrum. Старожилов я ничем не удивлю, а вот молодое поколение, которое про это только слышали, надеюсь, приобщиться к прекрасному.
Как выглядит импортозамещение ПО «из нашего окопчика» в солнечном Волгограде
Привет читателям Хабра! Меня зовут Степан, я руководитель ИНТЕРВОЛГИ. Мы (в основном) находимся в Волгограде и пишем коммерческие сервисы для средних и крупных компаний. С государством почти не работаем. Иностранной выручки у нас менее 1%, поэтому вопрос «а как мы будем работать дальше после февраля 2022?» – совсем не пустой.
В статье поделюсь опытом лидгена и продаж на волне «Импортозамещения в IT».
Как я в зеленом банке архитектором работал
Привет, друзья!
Все, описанное мной в этой статье, является пересказом моих личных наблюдений и моим личным мнением. Статья не несет в себе цели кого-либо порочить, но, возможно, подтолкнет кого-то из руководителей Сбера к изменениям в компании.
В конце 2021 года я работал архитектором в Ростелекоме. На тот момент, я работал в компании уже более двух лет, отлично знал своих коллег из разных департаментов, своих заказчиков, вел свой портфель проектов. У меня было отличное рабочее место, у окна, в офисе в новой высотке на Вернадского, режим посещения работы почти свободный. В те дни, когда я приезжал в офис, меня всегда ждали вкусные печеньки на кухне, и, иногда, ставшие к тому времени уже почти родными, коллеги по отделу архитектуры.
Все началось с моего желания расширить горизонты своих компетенций и сменить привычную работу технического архитектора на интригующую и казавшуюся мне такой волнующей работу корпоративного архитектора. Должности, отличающиеся всего на одно слово в составе названия, настолько сильно отличаются по фактуре работы.
Что такое цифровая рукописная подпись (ЦРП)
Русские буквы «Я», отличающиеся формой траектории, и пример нахождения экстремальных точек для быстрого сопоставления динамических кривых. Источник: Д.В. Колядин, И.Б. Петров, «Алгоритм выделения экстремальных точек применительно к задаче биометрической верификации рукописной подписи». Исследовано в России. — М.: МФТИ, 2005
Рукописная подпись с давних времён остаётся одним из самых популярных способов подтверждения документов. Состав рукописной подписи юридически не установлен. Это может быть имя и фамилия в рукописной форме или просто крестик (“Х”): любая произвольная совокупность символов, оформленных с использованием букв, безбуквенных элементов, всевозможных завитков и штришков.
Но сейчас обычный автограф — это больше, чем просто росчерк на бумаге. Он способен выполнять роль биометрического идентификатора, а понятие «подпись» значительно расширилось:
- Физическая подпись (wet signature): физическая отметка на документе, поставленная человеком собственноручно. Раньше её называли просто «подпись», но сейчас иногда специально указывают определение wet, чтобы не путать с электронной подписью (ЭП) и цифровой рукописной подписью (ЦРП).
- Электронная подпись (ЭП), она же цифровая подпись (ЦП), электронная цифровая подпись (ЭЦП).
- Цифровая рукописная подпись (ЦРП): собственноручная подпись человека, учинённая с помощью соответствующих программных средств (в том числе планшетов, дисплеев) для подтверждения целостности и подлинности подписываемого документа в электронном виде.
Неформальный Эксель: OpenGL, игры на GDI+ и инфографика теперь и в VBA
На Хабре уже было довольно много интересных публикаций с неформальным использованием Экселя (списочек под катом). Этой статьёй мне хочется поделиться с сообществом красивыми результатами нашего французского коллеги. Автор, Тьерри Гасперм (Thierry Gasperment), создаёт подобную красоту на VBA под Excel / Access / Word и VB6. Увы, сайт на французском, а материалы, хоть и свободны для использования, но для просмотра и скачивания зачастую требуют регистрации. По этой причине я поместил наиболее интересные примеры на свой GitHub. Для тех, кто захочет "выйти за пределы шахматной доски", советую всё же потратить пару минут своего драгоценного времени и зарегистрироваться на сайте. Оно того стоит, так как количество и качество информации на сайте Тьерри заслуживают того. Для регистрации и просмотра рекомендую Chrome: автоматический перевод Edge порождает "гуртовщиков мыши" и прочие химеры вроде "glutMouseРазумный" и "Силовая установка" (PowerPoint).
Обзор Музея криптографии в Москве
Редакция портала Хабр (в лице @lexxnimoff и @ancotir) побывала в музее криптографии, расположенном по адресу: Москва, улица Ботаническая, дом 25, строение 4. Показать экспозицию музея и рассказать о ней любезно согласились Анна Титовец, главный куратор музея, и Владимир Бельский, заместитель главы лаборатории криптографии компании «Криптонит».
Топ-30 онлайн-ресурсов для обучения детей основам программирования на Python
Владение языком Python станет прекрасным активом будущего программиста. Если ваш ребенок увлекается программированием, то процесс обучения можно разнообразить с помощью полезных видео, обучающих игр, вступления в тематические сообщества и многого другого. В этой статье мы собрали полезные ресурсы по Python и поделили их по категориям.
Небанальные правила чистого Python. Часть 1
Большинство питонистов не раз слышали о таких правилах как «функции должны быть глаголами» или «не наследуйтесь явно от object в Python 3». В этой статье рассмотрим не такие банальные, но полезные правила чистого кода в Python.
Делаем документацию здорового человека в Git на примере Docs Ozon
Казалось бы, с документацией всё просто — пишешь, публикуешь, поддерживаешь актуальность. Например, вот у нас в Ozon есть пользовательские инструкции на docs.ozon.ru: выглядит просто как текст на сайтике, что ж необычного-то в его размещении и в целом в работе техписателей?
Если начать раскапывать, всплывёт ещё несколько вопросов:
• где хранить тексты и почему Confluence не подходит?
• как красиво оформить документацию с помощью статических генераторов сайтов
• зачем техписателям знать git и CI/CD?
• в какой момент пора искать разработчиков в команду и превращать документацию в платформу?
На связи Катя — руководитель отдела технических писателей в Ozon, и сегодня расскажу о платформе Docs Ozon изнутри.
Легендарный: история самого высокооплачиваемого инженера-программиста из Google
Разумеется, это лишь шутка — про Джеффа Дина их ходит совсем не мало. Совсем скоро вы поймете, откуда «растут ноги» у баек об одном из самых легендарных программистов из Google.
Стайлгайд для технической документации: зачем нужен, из чего состоит, как его создавать
Дисклеймер: это продолжение темы о составлении правильной технической документации. В первой статье мы рассказали, какие цели преследуются при составлении инфраструктурной документации и какие у нее особенности. А теперь поговорим о том, как составить годный стайлгайд, чтобы документы были удобочитаемыми, консистентными и… может быть, даже красивыми :-)
Что такое стайлгайд?
Дословный перевод английского словосочетания Style guide — «руководство по стилю». Применительно к документации это набор правил и требований, включающий особенности стиля и тона изложения, оформления текста и структуры, использования терминологии и т.д.
Стайлгайд обеспечивает консистентность текста, ускоряет адаптацию новых сотрудников и экономит время, сводя к минимуму дискуссии о том, как правильно писать или оформлять текст.
Как автоматизировать рутинные операции с помощью Jupyter, Python и Selenium
Привет, Хабр! Меня зовут Николай Суворов, я руководитель направления в МТС Digital. Занимаюсь продуктом МТС Premium – это единая подписка на сервисы МТС и партнеров. Сегодня я расскажу о нашем опыте создания робота для автоматизации повторяющихся действий сотрудников с помощью Jupyter, Python и Selenium. Статья будет интересна прежде всего менеджерам, которые хотят оптимизировать свою работу. Разработчикам мой текст будет полезен с точки зрения понимания возможностей по ускорению повторяющихся действий в интерфейсах. Весь необходимый код – внутри.
Почему уходят из 1С?
Скромная "ответочка" на статью про то, что 1С-ники гораздо умнее коллег из других ЯП.
Как IT специалист, знакомый с теми и другими, постараюсь оппонировать утверждениям из оригинальной статьи.
Информация
- В рейтинге
- 2 256-й
- Откуда
- Москва, Москва и Московская обл., Россия
- Дата рождения
- Зарегистрирован
- Активность