Size: a a a

Technical Writing 101

2020 December 04
Technical Writing 101
Извините за задержку в постах, у главреда заболел кошак, пока животинка полноценно не излечится, скорость постов немного снизится.

Но не сегодня!

Сегодня у нас ❗️пятничный пост❗️ Пост об аудитории, о работе с ней, и кроме того, мы немножко макнём свои лапки в пучину истории.

———

Как я когда-то писал (в посте про Гелиограф), я очень люблю военную/армейскую документацию, ведь в ней нет ничего лишнего, она лаконична, прямолинейна и идеально работает с аудиторией (еще один мой пост про (kinda) военные доки.) В сегодняшнем посте - очередной пример такой документации.

———> (с) Highlights for Warspot: from the best angle
источник
Technical Writing 101
источник
Technical Writing 101
“Солдаты ничем не отличаются от детей, если верить шутливой и не очень приличной поговорке. В этом не было ничего плохого, пока военные были вооружены несложным оружием и использовали примитивную тактику, однако взрослым детям доверяли все более сложное вооружение, технику и обучали различным приемам по мере развития войны. С изобретением книгопечатания в игру вступили справочники и руководства пользователя, и внезапно выяснилось, что солдаты не любят читать скучные книги с мелкими шрифтами.

В конце концов было решено превратить обучение солдат в увлекательную игру.
Таким образом, Вторая мировая война принесла с собой целую часть учебной военной литературы с комиксами, наполненными девочками и анекдотами. Немцы превзошли самих себя - в Германии в полушутливой форме были опубликованы
инструкции по эксплуатации «Тигра» и «Пантеры», руководства, в которых учились десятки забавных способов уничтожения советских танков и объяснения для пилотов  Люфтваффе, как вести движущуюся цель, чтобы сбить Спитфайр.”
источник
Technical Writing 101
Причины менять интерфейсный текст могут быть очень, очень разные

https://twitter.com/MichaelSteeber/status/1334619509743874052?s=20
источник
2020 December 07
Technical Writing 101
Начало недели, не очень хочется нагружать и себя, и вас чем-то совсем уж узкопрофильным, поэтому предлагаю слегка отвлечься и почитать небольшую историю о создании своего собественного статик сайт генератора, и о важности личных пет-проджектов.

Читать: Why I Built My Own Shitty Static Site GeneratorWhy I Built My Own Shitty Static Site Generator

Bonus Track: Микро-история про создание спеллчекера в 84 году (хотя больше про стремительный прогресс технологий)
источник
2020 December 08
Technical Writing 101
Если вы утомились от бесконечных блогпостов, чтения чатиков и комментариев в LinkedIn/Telegram/Slack и хочется простого человеческого почитать книгу, то предлагаю вам подборочку книг по нашему с вами профилю.

Feel free делиться своими любимыми книженциями в комментариях 🙌

Смотреть подборку
источник
Technical Writing 101
Ноушн запускает доступ к API.

Готовимся к полному завоеванию Ноушном всего мира knowledge-sharing'а

https://www.notion.so/api-beta
источник
2020 December 09
Technical Writing 101
Не Ctrl-F’ом единым.

Статья о DocSearch от Algolia, лучшего поставщика поиска для приложений и сайтов.

Algolia привидит следующие пункты в пользу полноценного поиска, вместо обычного Ctrl+F, к которому так привыкли все:

1️⃣ Поиск по всему сайту документации, а не только по одной загруженной странице.

2️⃣ Допуск опечаток. Наш поиск исправляет неверные запросы и опечатки. Это ключевой момент при поиске неизвестных концепций или технологий.

3️⃣ Алгоритм разрыва связи. Эта уникальная концепция Algolia помогает мейнтейнеру лучше перенаправлять пользователей, помогая им в интерактивном режиме. Меньше необходимости в поддержке!

4️⃣ Аналитика. Наш поиск поможет вам понять, что делают ваши пользователи.

(больще - внутри статьи, все не влезло ↩️)

В статье никаких откровений, просто даю вам знать (если вы не знали) что есть такая клёвая и 💴 бесплатная 💴 тулза, и избавить вас от изобретения очередного велосипеда или если вас не устраивает условный lunr.js

Читать о DocSearch
источник
2020 December 16
Technical Writing 101
В последнее время вижу все больше и больше пользователей и советчиков (и без того популярного) MkDocs, поэтому вот вам два гайда, которые might come in handy на старте, так сказать:

1. Getting started with Material MkDocs — установка, кастомизация, публикация и траблшутинг.
2. Deploying MkDocs with Material theme to Netlify — название говорит само за себя
источник
Technical Writing 101
Why Free Software needs Free Documentation

—————————

Самый большой недостаток бесплатных операционных систем заключается не в программном обеспечении, а в отсутствии хороших бесплатных руководств, которые могли бы поставляться с этими системами. Многие из наших наиболее важных программ не поставляются с полными руководствами. Документация - неотъемлемая часть любого программного пакета; когда к важному пакету бесплатных программ не прилагается бесплатное руководство, это серьезный пробел. Сегодня у нас много таких пробелов.

—————————

Статья рассматривает проблемы проприетарных (не _ПЛАТНЫХ_) руководств и как всегда у GNU — про ущемление свобод.

Читать.
источник
2020 December 17
Technical Writing 101
Посыпаю голову пеплом, но только под конец 2020го узнал о Nielsen Norman Group.

Кто это такие?

NN/g — исследовательская и консалтинговая UX компания, которой доверяют ведущие организации по всему миру, среди клиентов NN: Google, Visa, Verizon, Sony, eBay (хотя UX ибэя по прежнему наводит страх и ужас, но может какой-то другой их проект), National Geographic и другие мастодонты индустрии.

Основатели —  Якоб Нильсен и Дон Норман, признанные во всем мире эксперты в области UX. Вместе они основали Nielsen Norman Group, элитную фирму, стремящуюся улучшить повседневный опыт использования технологий.

Дон Норман
Автор книги «Дизайн повседневных вещей», также он придумал и популяризировал термин «UX» на заре работы в Apple. Дон Норман был признан Newsweek «Guru of Workable Technology».

Якоб Нильсен
Автор юзабилити-чеклиста  “10 Usability Heuristics” и один из первых поборников юзабилити-тестирования. Якоб Нильсен был признан «Guru of Usable Web Pages» газетой New York Times.

Скачать “10 Usability Heuristics” можно по ссылкам ниже, а можно и почитать. 🤓

⬇️Downloads⬇️
Jakob's 10 Usability Heuristics All Posters (ZIP)
Jakob's 10 Usability Heuristics Summary Poster (PDF)
Jakob's 10 Usability Heuristics Summary Poster, A4 Size (PDF)
Jakob's 10 Usability Heuristics Summary Poster, Letter Size (PDF)

Сегодня хочу обратить ваше внимание на 10-й пункт в чеклисте - Help and Documentation

Help and Documentation: The 10th Usability Heuristic

—————————

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

Читать.
источник
2020 December 18
Technical Writing 101
Я уже делал много постов про комиксы, так как они очень дороги сердцам всего редакторского состава и не могу обойти стороной новый комикс-гайд. В этот раз про 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.

🧡💴
источник
2020 December 22
Technical Writing 101
От Google Docs не убежать, поэтому надо расслабиться и наслаждаться.

gSweet — экстеншн для Chromium-based браузеров который делает гуглдоки похожими на Notion, добавляя в них возможность использования слэш /  команд.

Пример на скрине выше.
источник
2020 December 24
Technical Writing 101
Я уже поднимал тему того, как GPT-2/3 могут помочь в нашей с вами работе. Так вот, кто-то решил возвести всё это дело в абсолют и создает специализированный сервис, который поможет найти вдохновение, и подобрать слова, когда “не идёт“. Пока что с GPT-2 и небольшим датасетом, но начало уже положено, и планы на GPT-3 уже намечены.

Алогритм берет последние написанные 40 символов, анализирует их и контекстно предлагает что писать дальше.

Похоже, скоро от писательского блока не останется и следа!

Посмотреть что там с AiToWrite
источник
2020 December 31
Technical Writing 101
Посоветовавшись и оценив свою аудиторию, весь редакторский состав пришел к мнению, что нашим подписчикам итак хватает поздравлений в ругих местах, но!

🎆 Но новый год же, епта! 🎆

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

🌲 C НАСТУПАЮЩИМ! 🌲
источник
2021 January 05
Technical Writing 101
Часть 1: Как написать самый мощный ворнинг в мире?

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

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

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

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

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

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

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

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

🙄

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

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

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

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