Technical Writing 101 🇺🇦
1.57K subscribers
244 photos
3 videos
12 files
418 links
Anything's A Documentation If You're Brave Enough

👋 @SuckMyNuts
Download Telegram
В далёком 2016 Airbnb поделились своей болью со скейлингом шаринга (простите) знаний и вариантами того, как это дело обуздать. В статье без откровений, но мне она нравится, подойдет как старт для тех, кто только задумался о построении системы по обмену знаниями внутри компании/команды.

И все эти годы они спокойно себе пилили свой 🚲. Судя по чейнджлогам - выглядит интересно. Делюсь, может кому подойдет.

Документация по этой системе живет тут

#knowledgemanagement #article #en #changelog #example
Дано: посудомойка с 5 режимами.

Необходимо: понять что делает второй пункт.

#example #en #visual
Вывод: опозориться можно и в документации, состоящей из одного слова и одной картинки. Иногда (при неумении/неопытности - всегда) лучше не креативить, а писать как есть. Только узнав и научившись как делать нужно, можно начать делать так, как хочется и гнуть (ну ладно, more like подгибать) правила под себя.

Hint: чтобы посмотреть правильный ответ, нажмите на 💡

#example
Я очень люблю узнавать о чужих процессах и читать о том как их строят и вообще о внутренней кухне. Недавно подвернулся сайтец Greater Greater Washington, на котором чуваки на волонтёрской основе топят за все хорошее и против всего плохого в своем округе, улучшают район и всячески его развивают.

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

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

Это пример отличной коммуникации и knowledge sharing attitude, будьте как Greater Greater Washington!

#example #career #en
ReadMe (которые personalized, interactive developer hubs) ведут офигенский documentation-related блог, рекомендую!

Сегодня попалась на глаза их обширная статья о том как начать вкатываться в Swagger + OpenAPI документацию. Темплейты, бест поактисы, тулзы и примеры. Всё к вашим услугам! Нормально подойдет для базовых познаний что там да как.

Бонус трек - Mockoon, мокалка API, которая умеет всё локально (No remote deployment, no account required, open source.), еще и кроссплатформенная.

#API #example #resource #article #en
Пишите понятную документацию, рисуйте её значками и символами если нужно, упрощайте, и делайте всё для людей, но будто для детей, чтобы небыло вот так:

https://twitter.com/jaredpalmer/status/1293537083399839744?s=20

Всем хорошей пятницы и приятных выходных

#example
Media is too big
VIEW IN TELEGRAM
Документация — не только буквы, но картинки и видео.

Тут недавно слили внутреннее обучающее видео прямиком из Apple. На видео учат сотрудником Apple Maps как подготовить машину с камерой к съемке, как эту съемку осуществлять и всякое такое. Не забыли даже напомнить о перекусе во время работы 🍟

Небольшой такой взгляд в закулисье knowledge sharing’a в Apple и на их внутренние тулзы. Если было интересно каково оно в гугломашинке — уверен, примерно также.

#video #example #en
Пятничка! 💫

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

Сегодня у нас в эфире инструкции к самой обсуждаемой железке конца 2020го года. Это то, с чем нам прийдется жить и на что смотреть изо дня в день ближайшие 4-7 лет, PlayStation 5!

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

Enjoy :}

Recommended settings:
https://youtube.com/watch?v=eMRsCR68tgQ

Using your account:
https://youtube.com/watch?v=H2DqsPh2d9k

Transfer files from PS4 to PS5:
https://youtube.com/watch?v=V8cmLeFQBT0

#example #video #visual
Что такое плохая документация? Каково пользоваться плохо задокументированным продуктом?

Почитайте как выглядит настоящая боль от плохой документации.

Я однажды приводил документацию Apple как хороший визуальный образец, но, как оказалось, хороша она в основном только визуально и отвечает только на базовые вопросы и показывает как работают самые простые сценарии. Если же сделать шаг влево или вправо, получается “it’s like you’re jumping off this cliff, and it’s like “good luck”. […]”

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

Если у вас есть примеры плохой документации хороших продуктов — велкам ту коммент секшн. Делитесь, жалуйтесь ну и всякое такое :}

#example #en #article
Шаблоны документации найти непросто, а хорошие шаблоны найти почти нереально.

Поэтому особенно пристально предлагаю ознакомиться с подборкой шаблонов (в Notion) на ВСЕ случаи жизни от Air!

#example #en #resource
Причины менять интерфейсный текст могут быть очень, очень разные

https://twitter.com/MichaelSteeber/status/1334619509743874052?s=20

#example #uiux
Я уже делал много постов про комиксы, так как они очень дороги сердцам всего редакторского состава и не могу обойти стороной новый комикс-гайд. В этот раз про Bash.

Прошлые комиксы в основом были от Джулии Эванс, как и вот этот вот. Она просто мастер простого и понятного визуального изложения совсем уж сложных вещей (кубернетесы, контейнеры, сеть, HTTP, Linux)

Делюсь этим не в ключе “читайте этот гайд”, а в ключе “смотрите как можно”, и не просто можно, а можно прямо КРУТО.

Bite Size Bash!

P.S:

При покупке обратите внимание на месседж под кнопкой покупки:

>Hello! It looks like you're in Ukraine, where this zine might be expensive.
>If you need it, please use this link to get 70% off the regular price.

🧡💴

#visual #example #en
1
Часть 1: Как написать самый мощный ворнинг в мире?

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

Ядерные отходы хранятся очень, очень долго и период их полураспада может длиться сотни, тысячи, а то и десятки тысяч лет, короче — гораздо дольше, чем проживем мы с вами, и, скорее всего наш язык и наши обыденные способы коммуницирования друг с другом. А как предупредить тех, кто наткнется на хранилище с отходами, но не знает ни языка и тем более не представляет себе что такое радиация?

В отчете Sandia за 1993г рекомендовалось, чтобы любое такое сообщение содержало четыре уровня возрастающей сложности:

Уровень I: Элементарная информация: «Здесь что-то рукотворное»
Уровень II: Предостережение: «Здесь что-то рукотворное, и это опасно»
Уровень III: Базовая информация: рассказывает, что, почему, когда, где, кто и как
Уровень IV: Комплексная информация: подробные письменные записи, таблицы, рисунки, графики, карты и диаграммы

#example #vintage #en
1
Часть 2

Отчет Sandia был направлен на то, чтобы передать серию посланий неязыковым способом любым будущим посетителям свалки. Он дал следующую формулировку, что должны вызывать эти сообщения:

- Это место - сообщение ... и часть системы сообщений ... обратите на это внимание!
- Для нас было важно отправить это сообщение. Мы считали себя могущественной культурой.
- Это место не почетное ... Здесь не отмечается никаких высокочтимых дел ... Здесь нет ничего ценного.
- То, что здесь было для нас опасным и отталкивающим. Это сообщение является предупреждением об опасности.
- Опасность находится в определенном месте ... она увеличивается к центру ... центр опасности здесь ... определенного размера и формы и ниже нас.
- Опасность все еще существует в ваше время, как и в наше время.
- Опасность для тела, это может убить.
- Форма опасности - это излучение энергии.
- Опасность возникает только в том случае, если вы существенно потревожите это место физически. Этого места лучше избегать и оставлять необитаемым.

#example #vintage #en
1
Часть 3

Но самой странной идеей из всех, как мне кажется, была идея из двух незамысловатых пунктов:

1. Создать кошек, которые меняют цвет в ответ на облучение радиацией.
2. Создать культуру / легенду / историю, согласно которой, если ваша кошка изменит цвет, вам следует переехать жить в другое место.

🙄

Идей нагенерено очень много, да и тема как раз для праздников, расслабить голову. + как-никак коммуникация и вроде даже "техническая”

Нашел для вас парочку годных статей как раз про вот это вот все:

Читать на Википедии
Читнуть на Vice
Глянуть на Medium

Отдельная документалка про меняющих цвет котов

#example #vintage #en
1
Пятничной документации пост.

Вообще сколь бы смешной эта картинка не была, как документация она отрабатывает на все сто. Тут вам и легкочитаемость и работа с аудиторией, и юморок, и эдж кейсы. Всё как надо 👀

#example #en
1
Для новоприбывших.

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

Поэтому я ищу всякую дурацкую документацию или какие-то спрятанные пасхалочки, и каждую пятницу показываю ее вам. Если есть примеры всяческой дуристики — шлите ее мне @SuckMyNuts

#example
1👍1