Pull to refresh
16
Karma
0
Rating
Ростислав @Rast1234

User

  • Posts
  • Comments

Откровения кофеин-зависимого инженера: как писать документацию

Timeweb corporate blogDevelopment ManagementProject managementTechnical Writing
Translation
image
Четыре вида документации распределнные по двум осям: практика-теория и обучение-работа.

Недавно вышли два нашумевших поста:


И многие спрашивали: «Кто-нибудь, пожалуйста, научите меня писать хорошую документацию».
Я не претендую на звание эксперта, но думаю, что хорошо с этим справляюсь.

Я выпил достаточно кофе, и я попытаюсь объяснить то, что знаю.

TL; DR: пишите документацию для решения конкретной проблемы для определенной группы людей, а не только для того, чтобы документация была.

Пишите хорошо


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

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

Самый полезный совет для написания документации — пишите в разговорном стиле. Воспринимать информацию из неформального текста намного проще.

Виды документации


Ладно, теперь вернемся к документации.
Читать дальше →
Total votes 27: ↑19 and ↓8 +11
Views4.7K
Comments 6

News

Show more

Многопоточность на низком уровне

JUG Ru Group corporate blogProgramming.NETC#Concurrent computing

Очень часто при обсуждении многопоточности на платформе .NET говорят о таких вещах, как детали реализации механизма async/await, Task Asynchronous Pattern, deadlock, а также разбирают System.Threading. Все эти вещи можно назвать высокоуровневыми (относительно темы хабрапоста). Но что же происходит на уровне железа и ядра системы (в нашем случае — Windows Kernel)?


На конференции DotNext 2016 Moscow Гаэл Фретёр, основатель и главный инженер компании PostSharp, рассказал о том, как в .NET реализована многопоточность на уровне железа и взаимодействия с ядром операционной системы. Несмотря на то, что прошло уже пять лет, мы считаем, что никогда не поздно поделиться хардкорным докладом. Гаэл представил нам хорошую базу по работе процессора и атомнарным примитивам.



Вот репозиторий с примерами из доклада. А под катом — перевод доклада и видео. Далее повествование будет от лица спикера.

Читать дальше →
Total votes 42: ↑41 and ↓1 +40
Views21.7K
Comments 16

Отложенные ретраи силами RabbitMQ

ДомКлик corporate blogInstant MessagingPythonProgrammingSystem Analysis and Design

Меня зовут Алексей Казаков, я техлид команды Клиентских коммуникаций в ДомКлике. В этой статье я хочу поделиться с вами «рецептом», который позволил нам реализовать отложенные ретраи при использовании брокера сообщений RabbitMQ


rabbit_retry
Читать дальше →
Total votes 20: ↑19 and ↓1 +18
Views6.5K
Comments 12

Советские мечты о будущем

Madrobots corporate blogScience fiction


Помните очаровательного котика, которые чихал в заставке советского мультфильма? Мы помним, и нашли его — вместе с ворохом другой рисованной фантастики. В детстве она пугала и обескураживала, поскольку поднимала серьезные, взрослые темы. Настала пора пересмотреть старые мультфильмы, чтобы узнать, о каком будущем мечтали в той стране.
Читать дальше →
Total votes 138: ↑136 and ↓2 +134
Views85.8K
Comments 144

Собеседуем работодателя или как не уволиться в первый месяц

IT career
Первый рабочий день и… о боже, что я тут делаю?! Нет, ну серьезно кто вообще так пишет код?
Дружный коллектив? Мои коллеги вообще заметили, что я вышел на работу?

Древний SVN, шумный опен спейс и «типа SCRUM», и это лишь малая часть из тех «приятных» сюрпризов, которые вас могут поджидать в первый рабочий день.
Знакомая ситуация?
Читать дальше →
Total votes 155: ↑134 and ↓21 +113
Views72.4K
Comments 176

Исповедь графомана

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

Я, как положено, на эти вопросы отвечал, но их стало так много, что решил изложить свой опыт в виде статьи. Цель ровно одна – централизованно рассказать о том, как я это делаю. Возможно, кому-то этот опыт поможет. А я просто буду давать ссылку на эту статью, когда получу очередной вопрос на тему «как ты пишешь всю эту хрень?».

Возможно, это последний мой текст, потому что вчера у меня в жизни случился крутой поворот.
Читать дальше →
Total votes 46: ↑34 and ↓12 +22
Views9.1K
Comments 25

Расширяя полотно картины Ван Гога “Звездная ночь” с помощью языка Wolfram Language (Mathematica)

Wolfram Research corporate blogEntertaining tasksProgrammingImage processing
Translation

Перевод поста Piotr Wendykier "Extending Van Gogh's Starry Night with Inpainting"
Скачать перевод в виде документа Mathematica, который содержит весь код использованный в статье, можно здесь (архив, ~8 МБ).


Могут ли компьютеры научиться рисовать, как Ван Гог? Определенно да, до некоторой степени! Для этого, подобно художникам-копиистам, алгоритму сначало потребуется взять некоторое оригинальное произведение, а затем он сможет на их основе создать что-то сам. Насколько хорошо он сможет с этим справиться? Пожалуйста, судите сами.

ExtendingVanGoghStarryNightInpainting_1.gif
Вторая премия на фотоконкурсе ZEISS
Читать дальше →
Total votes 117: ↑110 and ↓7 +103
Views75.2K
Comments 36

Опыт использования smart-очков Epson Moverio BT-200

AR and VRWearable electronics
Sandbox
Всем привет!

Итак, 10 июля сего года прикупил в Москве сие чудо технологий, дабы возрадоваться прогрессу! Прошёл месяц и, как говорится, накопилось. Решил написать-таки отзыв реального использования очков. А заодно и своего рода обзор возможностей AR-очков Epson Moverio BT-200. Так сказать, без прикрас и прочего маркетинга. Собственно, именно наличие гибкой и довольно полноценной ОС Android и сподвигли меня на эту заморочку. Сухие данные технических характеристик устройства можно спокойно узнать в интернете.
Читать дальше →
Total votes 31: ↑27 and ↓4 +23
Views16.8K
Comments 37

Overclock мозга или Внутренняя виртуализация сознания

BiotechnologiesBrain
Tutorial


Все помнят этот фильм? Какого черта он делает на Хабре? И вообще что тут делает подобный пост?
Наверное потому, что я считаю главным звеном в IT все таки человека, а точнее его мозги. Я попробую рассказать еще об одной возможности использовать свой мозг чуточку эффективнее. Одна из слабо задокументированных возможностей, которую мы используем каждый день, но не всегда даже об этом вспоминаем. Все описанное проверялось на мне. Если что-то я не пробовал, но рассказать об этом важно буду отмечать особо. Никаких наркотиков, аппаратов и издевательств над собой, только общедоступные легкие методики (короче, лег проспался и вперед, не вставая даже с кровати).
И да… Это до жути реалистично, на столько, что попробовав, вы не сможете не рассказать об этом.

Что бы не было лишних криков в комментах, попрошу всех кто ярых сторонников любой религии и конфессии, а так же убежденных эзотериков сразу поставить минус в карму и не читать дальше. Здесь не будет философии и великих вселенских тайн. А остальных прошу под кат — попробую рассказать о своей практике разгона мозга с помощью встроенных функций.
ночь как полигон для...
Total votes 224: ↑172 and ↓52 +120
Views246.5K
Comments 292

螢火蟲(Firefly): You can't take the sky from me

Lumber room
image
Данный пост посвящается сериалу режиссера 喬斯·溫登(Джосса Уидона) «Светлячок» 2002 года, который был закрыт из-за низких рейтингов, но как оказалось позже этот сериал стал одним из самых влиятельных в истории и продолжает вдохновлять людей на подвиги.

вот некоторые «последствия» сериала:
— в честь него почти что назвали модуль 国际空间站(МКС)
— футболка и DVD на 国际空间站 (МКС)
— фанат потратил 14 месяцев на сборку космического корабля 寧靜號 из 70 000 деталей
— в играх от Blizzard есть ссылки на сериал
— скоро выходит 编辑 (MMORPG) по мотивам
— помимо статей на imdb, лурке, 維基百科, кинопоиске (8.823), теперь есть пост и на Хабре
http://zh.wikipedia.org/wiki/螢火蟲_(電視劇)
— tai-kong suo-yo duh shing-chiou sai-jin wuh duh pee-goo

詳細信息, фото и видео под катом
Читать дальше →
Total votes 49: ↑22 and ↓27 -5
Views10.4K
Comments 18

Патч для гипервизора сознания

Biotechnologies
Sandbox
image

Недавно в топе Хабра появился пост, заставивший меня вылезти из read-only: «Overclock мозга или внутрення виртуализация сознания».
Вводящее в заблуждение название и не менее спорное содержание. Неприятные ощущения вызывает еще и тот факт, что при всей неточности и искажении фактов автор осмелился прикрепить к нему метку tutorial.

Желающих взглянуть на осознанные сновидения без налета авторской фантазии, прошу под кат.
Читать дальше →
Total votes 135: ↑113 and ↓22 +91
Views77.8K
Comments 168

Интересно и познавательно: полёт к МКС на ПТК НП

AstronauticsPhysicsGames and game consoles
Tutorial

Продолжаем цикл постов про Orbiter. Что меня очень порадовало, по статистике orbithangar.com после публикации второй статьи скачивали материалы и к ней и к первой статье. А сегодня мы, постепенно увеличивая сложность заданий, отправимся к МКС на перспективном транспортном корабле нового поколения (он же ПТС и ПТК НП).
Этот пост имеет следующие задачи:
  • Рассказать о РН «Ангара» и космодроме «Восточный».
  • Дать представление о физике маневров для осуществления стыковки.
  • Представить простое руководство для осуществления виртуального полёта к МКС и стыковки с ней.

Читать дальше →
Total votes 94: ↑94 and ↓0 +94
Views46.1K
Comments 14

Ультрагидрофобное покрытие

Lifehacks for geeks
Судя по рекламным роликам, состоит из основы и финального покрытия. Наносится спреем. Отталкивает воду изо всех сил.

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

Но ролики впечатляют, согласитесь.
Читать дальше →
Total votes 109: ↑99 and ↓10 +89
Views81.1K
Comments 266

Очень быстрый и эффективный способ расслабления глаз

Health

Предисловие


imageНе знаю, все ли программисты всесторонне любознательные люди, но я всегда пытаюсь получить фундаментальные знания во всех областях, которые могут быть практически полезны. В то время, когда мне в голову пришла эта идея я изучал анатомию и физиологию по журналам «Тело человека. Снаружи и внутри», ну а по работе я занимался стерео-варио фотографиями (для тех кто не знает — были такие советские календарики с ребристой поверхностью, где картинка либо казалась объемной, либо менялась). Так вот, в один из вечеров мне пришла в голову замечательная идея, которую я на протяжении уже 4х лет использую для поддержания своего зрения.
Обещаю, что эффект почувствуете сразу!
Читать дальше →
Total votes 246: ↑238 and ↓8 +230
Views193.4K
Comments 207

Рискую быть похищенным НЛО, но не показать не могу :)

Design
Интересно, что подумает НЛО о дизайне футболки, где обнаженная (ну, почти) девушка невербально посылает на три буквы засасывающий ее инопланетный корабль :)? Надеюсь, у НЛО есть самоирония.
Читать дальше →
Total votes 167: ↑106 and ↓61 +45
Views1.6K
Comments 57

Искушение воздушного старта

AstronauticsPhysics

Идея старта космического аппарата с воздушного носителя регулярно предлагается как способ радикального облегчения доступа человечества в космос. Однако, только одна ракета-носитель использует этот принцип. О том, чем выгоден и какие сложности создает воздушный старт, этот пост.
Читать дальше →
Total votes 120: ↑118 and ↓2 +116
Views82.9K
Comments 81

Как начать майнить для начинающих

Cryptocurrencies
Sandbox
Tutorial
Идея и название статьи подсказано юзером Xao в комментарии к недавнему посту Что делать с Bitcoin нам, обычным людям, а также многочисленными вопросами на Тостере. Эта инструкция поможет начать майнинг на обыкновенных компьютерах и ноутбуках под управлением ОС Windows или Linux в составе пула совместной генерации криптовалюты.

Как верно заметил dzzh
Смысла нет сейчас биткоин майнить. Какие-то мелкие монетки генерировать и через биржи в биткоин выводить — еще да.

Поэтому начать майнинг придется с выбора криптовалюты. Данная инструкция состоит из 5 простых шагов:
  1. Выбор форка
  2. Выбор пула
  3. Выбор майнера
  4. Запуск майнинга
  5. Вывод на свой кошелек

Читать дальше →
Total votes 44: ↑18 and ↓26 -8
Views525K
Comments 32

Свет и цвет: основы основ

DesignPhotographic equipment
Piccy.info - Free Image Hosting
Мы часто говорим о таком понятии как свет, источниках освещения, цвете изображений и объектов, но не совсем хорошо себе представляем, что такое свет и что такое цвет. Пора разобраться с этими вопросами и перейти от представления к понимаю.
Читать дальше →
Total votes 86: ↑62 and ↓24 +38
Views168.4K
Comments 59

Управление движением в играх

History of ITGames and game consoles
Пересматривая свою старую публикацию об истории Nintendo я наткнулся на рекламу Power Glove — контроллера для приставки NES, который был выпущен в 1989 году. До сих пор я считал, что управление движением в игровой индустрии началось именно в эпоху Nintendo Wii, PlayStation Move, Microsoft Kinect — непростительная ошибка.

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

image

Вам есть, что добавить? Пожалуйста, напишите об этом в личных сообщениях или комментариях!
Читать дальше →
Total votes 17: ↑14 and ↓3 +11
Views22.6K
Comments 21

Information

Rating
5,776-th
Location
Екатеринбург, Свердловская обл., Россия
Registered
Activity