Всё для технического документирования
+7 (925) 328-76-00
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Новости о техническом писательстве

Лучшие умы человечества о документировании (часть 3)

24.03.2017

Если вы ещё не устали от шуточных цитат Георгия Полищука, но устали от сплошной философии, то держите продолжение в известных стихах (и не только).

Первая часть: Лучшие умы человечества о документировании

Вторая часть: Лучшие умы человечества о документировании-2

Читать дальше…



Лучшие умы человечества о документировании (часть 2)

17.03.2017

Представляем вам вторую часть юмористической заметки от нашего выпускника Георгия Полищука. Первая часть: Лучшие умы человечества о документировании

С пятницей! 🙂 Читать дальше…



Лучшие умы человечества о документировании

22.02.2017

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

 

Не читай документацию, Гертруда!

(У.Шекспир)

 

Шуточки Название работы / цитата ИРЛ
Документация — опиум для службы поддержки (К.Маркс) Религия — опиум для народа (К.Маркс)
Заметили ли, что документирование закрепощает аналитический ум? Ломает крылья бизнес-анализу? Что становишься тем более аналитиком, чем более становишься техписателем? — Серое небо абстракции как-бы бороздят молнии; свет достаточно силён для всего филигранного в вещах; задачи в JIRA с типом Epic близки к завершению; проект, озираемый как бы с позиции заказчика. — Я определил только что трудовой пафос. — И неожиданно ко мне в почтовый ящик падают новые письма, маленький град из уведомлений и прочего бреда, из незадокументированых задач… (Ф.Ницше) Заметили ли, что музыка делает свободным ум? Даёт крылья мысли? Что становишься тем более философом, чем более становишься музыкантом? — Серое небо абстракции как бы бороздят молнии; свет достаточно силён для всего филигранного в вещах; великие проблемы близки к постижению; мир, озираемый как бы с горы. — Я определил только что философский пафос. — И неожиданно ко мне на колени падают ответы, маленький град из льда и мудрости, из решённых проблем…

(Ф.Ницше)

Без документации жизнь была бы ошибкой (Ф.Ницше) Без музыки жизнь была бы ошибкой (Ф.Ницше)
Аналитика есть бессознательное метафизическое упражнение души, не ведающей, что скоро она должна будет еще и документировать (А.Шопенгауэр) Музыка есть бессознательное метафизическое упражнение души, не ведающей, что она философствует (А.Шопенгауэр)
Документируй так, как если бы максима твоего технического текста могла бы быть всеобщим законом для пользователей продукта (И.Кант) Поступай так, как если бы максима твоей воли могла бы быть всеобщим законом (И.Кант)
Вечное возвращение документации. С цикла согласования (Ф.Ницше) Вечное возвращение (Ф.Ницше)
Единственное преступление — это бездарная документация (О.Уайльд) Единственное преступление — это бездарность (О.Уайльд)
О чем нельзя говорить, то следует задокументировать (Л.Витгенштейн) О чем невозможно говорить, о том следует молчать (Л.Витгенштейн)
Документировать или идти обедать, — вот в чем вопрос (У.Шекспир) Быть или не быть, — вот в чем вопрос (У.Шекспир)

 

Продолжение следует…



Как отличить технического писателя от автора маркетинговых текстов

27.08.2015

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

Технические коммуникации VS Маркетинговые коммуникации. Рисунок за авторством Antonio Prohias был впервые опубликован в январе 1961 года в журнале Mad Magazine (#60)

Технические коммуникации VS Маркетинговые коммуникации. Рисунок за авторством Antonio Prohias был впервые опубликован в январе 1961 года в журнале Mad Magazine (#60)

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

Хотите серьёзно заниматься техническими текстами? Тогда вам просто необходимо пройти курс для настоящих технических писателей!


Для внешнего мира, для тех, кто «не в вашей песочнице», может быть сложно с первого взгляда отличить типичного технического писателя от типичного маркетингового писателя (то есть, автора маркетинговых текстов). А для того, кто живёт одной из этих профессий, разница очевидна. Если вам, вашим коллегам или друзьям трудно отличить их, воспользуйтесь простым списком, приведённым ниже, чтобы знать, какой бейджик бы подошёл человеку – технический писатель или маркетинговый. Это может помочь вам избежать часов, проведённых в состоянии фрустрации, и не задеть чувства обеих сторон… Читать дальше…



Руководство по выживанию в праздники для технических писателей 1.0

26.12.2014

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


 

Праздники уже не за горами. Это время семейных посиделок. И переполненных парковок, длинных очередей в каждом магазине и праздничной музыки, бьющей по ушам, куда бы мы не пошли. Вы вешаете гирлянды, напевая Jingle Bells себе под нос, и, пока пальцы не начинают замерзать, потягиваете пряничное латте. Эти времена могут быть стрессовыми, поэтому ознакомьтесь с Руководством по выживанию в праздничные дни от технических писателей из STC New England, чтобы пережить эти дни с минимальным стрессом, и, возможно, даже немного расслабиться. Читать дальше…



Старая шутка о лампочке применительно к техническим писателям

08.08.2014

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


Сколько нужно технических писателей для того, чтобы задокументировать замену лампочки? ДЕСЯТЬ!

1 чтобы обеспечить остальных соответствующими материалами (лампочка, лестница, и т.д.)

1 чтобы заменить её;

1 чтобы задокументировать процесс;

1 «графический эксперт» чтобы добавить рисунков лампочки в текст;

1 чтобы отредактировать черновик;

1 чтобы заменить лампочку, следуя новой документации;

1 чтобы удостоверится, что свет включён;

1 чтобы передать документацию техническим писателям, сидящим в темноте;

1 чтобы управлять всем проектом;

и, конечно же…

1 чтобы пойти к руководству и объяснить, что в следующий раз они НЕ СМОГУТ закончить это задание без дополнительных ресурсов!

Да, вроде всё верно, но смогут ли технические писатели сидеть в темноте и ЧИТАТЬ инструкцию по замене лампочки?

А теперь вопрос к читателям – сколько же техписов нужно, чтобы сменить лампочку?

Источник: Technical Writer’s version of old Light Bulb joke



Светлая сторона технической документации

18.07.2014

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


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

Была ли жизнь писателей проще до появления компьютеров?

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



Как создать жуткую ЧаВо-страницу

11.06.2014

11.06.14Страничка часто задаваемых вопросов – мощный инструмент выстраивания коммуникации с клиентом, зачастую незаслуженно забытый. Но если вы взялись за создание такой страницы, не переусердствуйте. И ни в коем случае не следуйте советам Сьюзен Сент-Мор.


Cтраницы ЧаВо – ещё один отличный способ продвижения вашего бизнеса, не так ли? Не берите в голову, что клиенты и возможные клиенты действительно могут спросить. Это просто страница, где вы можете указать «вопросы», которые вы бы хотели, чтобы ваши клиенты спрашивали, поэтому дам вам несколько советов, которые необходимы для увеличения продаж.

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



Следуйте инструкции и всё получится

23.05.2014

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


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

Именно поэтому мы просим вас:

ПРОЧТИТЕ ДАННОЕ РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ, ПРЕЖДЕ ЧЕМ РАСПАКОВАТЬ УСТРОЙСТВО. ВЫ УЖЕ РАСПАКОВАЛИ ЕГО, НЕ ТАК ЛИ? ВЫ РАСПАКОВАЛИ ЕГО И ПОДКЛЮЧИЛИ ЕГО К КОМПЬЮТЕРУ, И ПОИГРАЛИ С КНОПОЧКАМИ, А ТЕПЕРЬ ВАШ РЕБЁНОК, ТОТ ЖЕ РЕБЕНОК, ЧТО СУНУЛ СОСИСКУ В ВИДЕОМАГНИТОФОН И ПОСТАВИЛ ЕГО НА «БЫСТРУЮ ПЕРЕМОТКУ», ЭТОТ РЕБЕНОК ТОЖЕ ИГРАЕТ С КНОПОЧКАМИ, НЕ ТАК ЛИ? ВЫ ЗНАЕТЕ, ЧТО МЫ ПРОСТО МОГЛИ УНИЧТОЖИТЬ ЭТО УСТРОЙСТВО ЕЩЁ НА ЗАВОДЕ, ДО ТОГО, КАК ОТПРАВИТЬ ЕГО ВАМ? Читать дальше…



Как задокументировать звук?

16.05.2014

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


Немножко вас заинтригую – вы когда-нибудь пробовали письменно задокументировать звук? Кажется невозможным, не правда ли?

Судя по всему, технические писатели компании Electrolux нашли весьма творческий способ это сделать. На картинке описаны звуки (шумы) издаваемые холодильником при нормальной работе: Читать дальше…