Обновить
390
-1
Александр Клименков@AKlimenkov

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

Отправить сообщение

Один рабочий день технического писателя: правки, конфликты, редактура, релиз

Время на прочтение6 мин
Охват и читатели8.1K

Утренний кофе выпит, бутерброд съеден, довольные коты накормлены. Федя сразу включается в работу — дел много, нужно всё успеть. Но для начала нужно обновить локальные исходники разделов из репозитория. Это не первый его релиз. И Фёдор уже привычно запускает синхронизацию.

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

Читать далее

User guide. Как написать хорошее и полезное руководство пользователя

Время на прочтение6 мин
Охват и читатели9.9K

Древнее и сакраментальное RTFM преследует нас повсюду. Волей-неволей мы вынуждены постоянно читать инструкции: к технике, приборам, приложениям, системам.

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

В статье расскажу о пяти важных блоках информации, которые обязательно должно содержать руководство пользователя (оно же User Guide).

Читать далее

К вопросу о кошмарном качестве книг по программированию. Моя не наглядная книга о наглядном CSS

Время на прочтение6 мин
Охват и читатели23K

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

И дело даже не в кривом переводе. Мы уже давно научились догадываться, что именно «хотел сказать автор» на языке оригинала. Этот этап повсеместного падения качества книг уже пройден. Теперь издательства нацелились на новые антирекорды — соревнуются, кто кого переплюнет по количеству фактических ошибок в своих творениях. Например, по ужасающим косякам в исходных кодах примеров программ. Каждый раз хочется воскликнуть: «Ребята, вы сами-то хоть один раз перечитали своё творение?!»

Читать далее

Autism spectrum disorders and a career in IT: personal experience

Время на прочтение15 мин
Охват и читатели12K

I'm stunned by the illogicality of others, and they are stunned by the fact that I'm a robot." This phrase perfectly describes the peculiarities of my interaction with the world around me. I'm like this robot. Or an alien. I can only guess how the other people see me. But now I know for sure that others consider me at least strange. The feeling is mutual. Many actions of people around me seem completely irrational and illogical to me.

For a long time, this baffled me. I didn't understand what was going on, and considered myself a deep introvert, a withdrawn, gloomy dude who did not understand people and their feelings at all. I kept wondering what was wrong with me…

Read more

Порядок против хаоса. Как организовать личную базу знаний и заставить свои знания работать

Время на прочтение14 мин
Охват и читатели9.4K

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

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

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

Читать далее

Через слайды к звёздам. Секреты оформления и подготовки презентаций

Время на прочтение6 мин
Охват и читатели8.5K

Этим летом мне повезло побывать на очень интересной научно-популярной лекции Владимира Сурдина про перспективы полётов на Марс. В зале был полный аншлаг, мы с другом очень удачно купили билеты, приехали немного заранее и заняли места недалеко от сцены. Погас свет, Владимир Георгиевич под бурные аплодисменты вышел к аудитории и началось волшебство. Своим спокойным, негромким, приятным и интеллигентным, но при этом очень чётким и уверенным голосом он рассказывал о каналах Скиапарелли, ракетах Илона Маска и загадочных геологических образованиях на Марсе.

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

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

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

Читать далее

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

Время на прочтение5 мин
Охват и читатели6.1K

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

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

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

Читать далее

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

Время на прочтение5 мин
Охват и читатели1.5K

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

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

Читать далее

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

Время на прочтение6 мин
Охват и читатели10K

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

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

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

Читать далее

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

Время на прочтение5 мин
Охват и читатели7.8K

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

Читать далее

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

Время на прочтение6 мин
Охват и читатели5.3K

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

Читать далее

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

Время на прочтение5 мин
Охват и читатели60K

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

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

Читать далее

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

Время на прочтение4 мин
Охват и читатели33K

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

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

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

Читать далее

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

Время на прочтение4 мин
Охват и читатели9K

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

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

Читать далее

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

Время на прочтение15 мин
Охват и читатели18K

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

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

Читать далее

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

Время на прочтение5 мин
Охват и читатели11K

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

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

Читать далее

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

Время на прочтение12 мин
Охват и читатели3.8K

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

Читать далее

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

Время на прочтение5 мин
Охват и читатели10K

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

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

Читать далее

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

Время на прочтение4 мин
Охват и читатели2.8K

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

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

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

Читать далее

Разработка пользовательской документации: как писать качественные документы

Время на прочтение7 мин
Охват и читатели6.4K

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

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

Читать далее

Информация

В рейтинге
Не участвует
Откуда
Санкт-Петербург, Санкт-Петербург и область, Россия
Работает в
Зарегистрирован
Активность