Pull to refresh
377
0
Александр Клименков @AKlimenkov

Техлид, технический писатель, программист

Send message

Строкам грустно в одиночестве. Мои простые правила оформления списков

Reading time5 min
Views9.1K

Недавно я в очередной раз прочитал на Хабре, что списки — это один из признаков текста, созданного нейросетью. Значит меня можно считать «нейросетью» устаревшей модели, выпущенной ещё в 70-х годах XX века. Я начал составлять списки в детстве, почти сразу, как только научился писать.

Я очень люблю списки: они позволяют легко и в то же время наглядно структурировать информацию. По эффективности списки находятся где-то между обычным текстом, в котором объекты перечисляются в строке через запятую, и таблицей, которая по сути является двухмерным списком. Взгляд читателя легко скользит по номерам или маркерам списка. Можно быстро оценить количество строк, понять их последовательность и структуру, перейти к нужной строке.

В этой статье я хочу поделиться с вами своими правилами оформления списков.

Читать далее

Обучение и воркшопы: как виртуозно познакомить заказчика с новой функциональностью

Reading time5 min
Views1.8K

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

В статье расскажу о том, как строится весь процесс, о технических сложностях и закулисье...

Читать далее

Список дел в бумажном блокноте — островок реальности в виртуальном море

Reading time6 min
Views13K

Каждый день мы с вами занимаемся тем, что усердно и сосредоточенно размечаем сектора дисков в сложном продуманном порядке. Вся наша компьютерная деятельность в итоге сводится именно к этому. Результаты всех наших трудов — это виртуальные числа, ненадёжные заряды на хрупких носителях. От небытия их отделяет всего несколько нажатий клавиш. Как же иногда хочется добавить в рабочий процесс чего-нибудь материального, вещественного, аналогового.

Наверное, поэтому многие предпочитают вести списки дел на бумажных носителях. Безусловно, в бумажном блокноте не запустишь поиск, не поменяешь строки местами, не сотрёшь бесследно ошибочно написанное слово. Но все эти недостатки меркнут перед главным достоинством бумажного блокнота: он РЕАЛЬНЫЙ. Его можно потрогать, взять в руки, перелистать, насладиться фактурой бумаги и обложки.

Мне больше всего нравятся три системы, на базе которых можно сформировать свой индивидуальный набор правил ведения списков.

Читать далее

Мои простые правила хорошего текста: личное руководство по стилю

Reading time5 min
Views13K

Известно, что инструкция — это документ, который обычно читают в двух случаях: когда нечего читать или когда уже всё сломано. Сегодня я хочу рассказать вам про инструкцию, которую читают в третьем случае: когда нужно что-нибудь написать. Это — руководство по стилю.

Читать далее

Ошибки моей компьютерной молодости: первая научная работа, первый сайт и первый поисковик

Reading time6 min
Views8.2K

Недавно мне потребовалось предоставить кое-куда копию моего школьного аттестата. Я легко отыскал его в ящике с документами — маленькая тёмно-зелёная корочка со стойким запахом дерматина, характерным для старых документов прошлого века. В аттестат был вложен согнутый пополам «Табель итоговых оценок успеваемости» — тоже на гербовой бумаге, да ещё и с водяными знаками. Я с интересом и не без удивления изучил свои выпускные оценки («Читал аттестат — много думал») и надолго завис, погрузившись в воспоминания... И самые первые опыты программирования на Turbo Pascal, и первые отчёты в новеньком Microsoft Word, и всякие глупые ошибки в постижении компьютерных премудростей. О них мне и захотелось рассказать.

Читать далее

Удивительная недоказанная математическая гипотеза об одиноком бегуне

Reading time5 min
Views78K

Математики — удивительные люди. Они обожают неразрешимые проблемы и недоказуемые гипотезы. Их хлебом не корми, дай только придумать какую-нибудь заковыристую задачу и дать ей какое-нибудь удивительное название. И ладно бы, если эти задачи были просто абстрактными упражнениям для ума. Но ведь как-то так получается, что многие из них имеют принципиальное значение для развития науки. Как заклинившая гайка — пока не открутишь, дальше не попадёшь.

Вот и гипотеза об одиноком бегуне оказалась одной из таких задач...

Читать далее

Всё своё ношу с собой. Мои простые правила организации личной базы знаний

Reading time4 min
Views54K

Помните те времена, когда Интернет был маленьким, модемы — медленными, а провайдеры — жадными? Мы сохраняли всё полезное у себя на винчестерах, героически пытаясь вместить всё нужное в скромный объём дискового пространства. Раньше это был единственный способ обеспечить себе быстрый и эффективный доступ к информации.

А потом высокоскоростной Интернет нас избаловал — мы перестали скачивать файлы и формировать свои собственные локальные библиотеки знаний и контента. Теперь всё лежит на сайтах и в облаках. Зачем что-то скачивать, если всё это моментально доступно по одному клику?

Но, похоже, настало время вернуться к истокам. Всё чаще оказывается, что нужный контент становится недоступным или меняется до неузнаваемости...

Читать далее

Синей пеленой экран заполнил чистый DOS. Доска почёта и респекта: лучшие программные решения и интерфейсы

Reading time4 min
Views14K

В большинстве современных книг есть такой раздел — «Благодарности». Автор благодарит своих редакторов, учителей, друзей, родственников, любимых котов и всех тех, без кого книга никак не могла появиться на свет. Книгу я писать не планирую, а сказать спасибо за всё хорошее можно и в посте на Хабре.

В своём посте благодарности я хочу перечислить не имена людей, а интерфейсные и программные решения, которые здорово упростили мне (как и многим другим пользователям) жизнь в IT-мире. Впрочем, за каждой программой стоят её создатели. Поэтому мой список — это прежде всего выражение признательности тем прекрасным людям, которые смогли реализовать что-то действительно удобное и полезное.

Читать далее

«Каждый имеет право быть похожим на себя». Расстройство аутистического спектра и карьера в IT: личный опыт

Reading time15 min
Views27K

«Я офигеваю от нелогичности окружающих, а они — от того, что я робот». Эта фраза идеально описывает особенности моего взаимодействия с окружающим миром. Я такой же робот. Или инопланетянин. Я могу только догадываться, каким я кажусь со стороны. Но теперь я знаю, что другие считают меня по меньшей мере странным. Это взаимно. Многие поступки окружающих людей кажутся мне совершенно нелогичными и иррациональными.

Долгое время это ставило меня в тупик. Я не понимал, в чём дело, и считал себя глубоким интровертом, замкнутым мрачным типом, совсем не понимающим людей. Всё гадал, что же со мной не так...

Читать далее

Чудесное совпадение или плагиат в квадрате

Reading time5 min
Views19K

На Хабре периодически появляются разгромные статьи на тему, какой нынче Хабр стал «плохой», «злой», «корпоративный». О том, что он совсем «не торт», «скатился» и вообще «пробил дно». Вы, наверное, также помните проникновенные посты в духе «Прощай, Хабр». Многие хорошие люди покинули сайт, и на то были веские основания.

Теперь я сам оказался в такой ситуации, что просто не могу молчать. Настала моя очередь написать о том, какой Хабр… Тут по-хорошему должно быть какое-то изобличающее прилагательное, которое калёным железом выжигает все пороки нынешнего Хабра. Нет, здесь не будет моего манифеста на тему «уйду и больше не приду», все непечатные слова я также предпочёл оставить за скобками...

Читать далее

Компьютерра 2006. Про Винни-Пуха, кролика Билли и компьютерные программы

Reading time12 min
Views6.4K

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

Читать далее

Бумажные книги по программированию — удобный инструмент или пережиток прошлого?

Reading time5 min
Views16K

Нашёл у себя в ящике стола один очень старый каталог книг Microsoft Press за 1988–89 годы. Мне нравится иногда его доставать, перечитывать описания компьютерных книг тех лет, разглядывать их обложки. Да и просто названия книжек из этого проспекта заставляют погрузиться в ностальгическое настроение.

Сейчас заметную часть моей библиотеки по-прежнему составляют книги по программированию. Но я всё чаще задумываюсь о том, стоит ли покупать бумажные издания по компьютерной тематике...

Читать далее

Как правильно писать и оформлять примечания к техническим текстам. Почему светофор важнее Шекспира

Reading time4 min
Views3.8K

У химиков есть известная байка, которую они любят рассказывать молодому поколению. Главный герой этой истории — студент, который пошагово воспроизводил методику одного химического эксперимента из учебника. Он старательно выполнил очередной шаг «добавьте азотную кислоту» и... в лаборатории прогремел взрыв! Когда впоследствии стали разбираться, в чём же дело, выяснилось, что на следующей странице учебника было написано: «... медленно, по каплям».

Примечания и уточнения — очень важный элемент любого технического и научного текста. В любом документе фрагменты текста можно ранжировать по важности и критичности излагаемых сведений. Бывает просто обычный текст, который течёт себе ровно, как спокойная равнинная река. Бывают фрагменты с дополнительной, необязательной, уточняющей информацией: автору хотелось их добавить в текст, но они плохо укладываются в основную логику изложения материала. А ещё бывают критичные замечания и уточнения, которые обязательно должны быть обвешаны мигающими сигнальными огнями, сиренами, хлопушками и прочими средствами привлечения внимания читателя.

Как же лучше писать и оформлять примечания в технических текстах?

Читать далее

Почему пользователи ненавидят вашу документацию и как это исправить

Reading time7 min
Views9.7K

«Ваша документация — отстой!», «Я её никогда не читаю, всё равно там ерунда написана!», «Эти документаторы опять всё напутали», «Да любая нейросеть быстро напишет это в сто раз лучше», «Там никогда не найти ничего нужного», «А разве у нас есть документация?»

Обратная связь от читателей-пользователей далеко не всегда бывает конструктивной и вдохновляющей. Почему же так получается? Давайте разберём пять основных претензий читателей к технической документации и подумаем, что со всем этим делать.

Читать далее

Чудесное совпадение или ожидаемая связь: почему π²≈g

Level of difficultyEasy
Reading time5 min
Views113K

Давайте ненадолго перенесёмся в школьные годы и вспомним уроки математики и физики. Помните, чему равно число π? Естественно, помните, мы же на Хабре! А чему равно π в квадрате? Это тоже странный вопрос. Конечно, 9,87. А чему равно ускорение свободного падения g помните? Ещё бы, это число так тщательно вдолбили в нашу память, что захочешь — не забудешь: 9,81 м/c². Конечно, оно может варьироваться, но для решения базовых школьных задачек мы обычно использовали именно это значение.

А теперь, внимание, следующий вопрос: а с какого это перепугу π² примерно равно g?

Читать далее

4 стихии программной документации. The Grand Unified Theory of Documentation

Level of difficultyMedium
Reading time8 min
Views5.6K

В статье я хочу рассказать об одной очень интересной теории разработки документации на системы и программы. Её авторы утверждают, что создали ни много ни мало «Великую Единую Теорию Документации» (The Grand Unified Theory of Documentation). Мы привыкли с опаской относиться к заявлениям о том, что кто-то обнаружил сокровенную истину и раскрыл её профессиональному сообществу. В теории изложены идеи и правила, которые мы встречаем в разных методиках разработки документации и сами применяем на практике.

Основная ценность этой теории не в том, что она раскрывает некое сокровенное секретное знание, а в аккуратной систематизации этого самого знания и в полезных советах по разработке каждого типа документа. Не скажу, что я на 100% согласен со всеми правилами, изложенными в теории, но в ней есть много полезных и рациональных мыслей. В любом случае, она стоит того, чтобы с ней ознакомиться.

Читать далее

Странная история о вездесущих тараканах. Сбой в матрице или когнитивный феномен?

Reading time5 min
Views11K

Расскажу вам об одном странном случае. Вспоминали далёкое прошлое и старую ленинградскую коммунальную квартиру на Васильевском острове: общую кухню, в которой водились полчища тараканов. Посмеялись мы тогда, обсудили разные гипотезы. Поговорили о тараканах и забыли.

Через некоторое время одно из мобильных приложений выдало мне рекламу... тараканов. Предлагалось приобрести жирненьких мадагаскарских тараканчиков по необременительной цене. В этом не было бы ничего странного — мало ли что сейчас рекламируют в сети — если бы не загадочное обстоятельство: во время той самой беседы о тараканах рядом не было ни одного электронного девайса...

Читать далее

17 вредных советов для тех, кто проверяет документацию и технические тексты

Reading time3 min
Views6.9K

Вы пишете документацию, статьи или другие тексты? Тогда наверняка у вас есть проверяющие. Я уверен, что вы нежно и трепетно любите своих проверяющих. Вы, скорее всего, с нетерпением ждёте, когда они пришлют вам свои правки и комментарии. Благоговейно изучаете и перечитываете крупицы мудрости, которыми проверяющие благосклонно поделились с вами. Лучшие из комментариев вы записываете в специальную тетрадочку или даже распечатываете и вешаете их на стену...

Я начал коллекционировать самые фееричные комментарии. Делал я это для того, чтобы иметь перед глазами антипример — как ни в коем случае нельзя писать комментарии к текстам. Эти советы — тщательно отобранные, систематизированные и дистиллированные советы для проверяющих. Практическое руководство по доведению до белого каления ваших технических писателей и авторов.

Дисклеймер. Все совпадения фрагментов этого текста с реальными комментариями в вашей документации совершенно случайны. При написании этого текста не пострадал ни один проверяющий.

Читать далее

Почему FAR — центр моей компьютерной вселенной

Reading time4 min
Views63K

Какую программу вы обычно запускаете сразу после загрузки операционной системы? Кто-то сразу стартует браузер — поглядеть, кто там сегодня в Интернете (на Хабре) неправ. У многих — это редактор кода: «Я, как утром встал, сразу за дрель!». Возможно, вы сначала привычно открываете мессенджеры и почту — проверить, что там нового и важного.

Я обычно сразу после запуска операционки открываю свой Любимый Файловый Менеджер. Это «переходящее звание» — в разные периоды моего компьютерного прошлого этой чести «удостаивались» разные приложения с классическим двухпанельным интерфейсом. Сначала это был простой, но универсальный Norton Commander. Потом появился DOS Navigator со всяческими классными фичами: CD-плеер, телефонная книга с дозвоном по модему, встроенный табличный редактор и прочие прекрасные и поразительные для тех лет вещи.

Когда Windows прочно вытеснил DOS и все понемногу забыли про файл autoexec.bat, звание моего любимого файлового менеджера плавно перешло к Total Commander. Он продержался довольно долго, но в какой-то момент в мою жизнь буквально ворвался FAR...

Читать далее

Иллюзия неизменного прошлого. Хаос реальности или неуловимая волна парадоксов

Reading time7 min
Views7.6K

Мир находится в постоянном движении, вид за окном неуловимо меняется каждую секунду и никогда не повторяется дважды. Однако мы привыкли к относительной стабильности окружающей реальности. Будущее пугает нас своей неизвестностью и непредсказуемостью. Мы пытаемся его прогнозировать, строить какие-то долгосрочные планы. Но в любой момент может произойти «маловероятный» катаклизм и мы поймём, что все прогнозы погоды оказались пустышкой. Совсем другое дело — прошлое. Оно кажется нам надёжным и неизменным...

Читать далее

Information

Rating
Does not participate
Location
Санкт-Петербург, Санкт-Петербург и область, Россия
Registered
Activity