Получи случайную криптовалюту за регистрацию!

Technical Writing 101 🇺🇦

Логотип телеграм канала @technical_writing — Technical Writing 101 🇺🇦 T
Логотип телеграм канала @technical_writing — Technical Writing 101 🇺🇦
Адрес канала: @technical_writing
Категории: Технологии
Язык: Русский
Страна: Украина
Количество подписчиков: 1.63K
Описание канала:

Anything's A Documentation If You're Brave Enough
👋 Никита (@SuckMyNuts)

Рейтинги и Отзывы

3.50

2 отзыва

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

5 звезд

1

4 звезд

0

3 звезд

0

2 звезд

1

1 звезд

0


Последние сообщения 5

2021-07-14 16:02:40
Kathy Korevec, Продукт Манагер из GitHub, написала занимательнейшую статью с просто горооой размышлений о том, как улучшить документацию в GitHub. Кроме того, она нагенерировала еще ведро идей о том, как оптимизировать документацию для разработчиков, и подкрепила их мокапами. Говорит о необходимости “многоформатности” документации, об оптимизации поиска, в общем очень интересный взгляд внутрь головы продукт манагера довольно таки большой компании, рекомендуется к прочтению.

Читать: Maybe it’s time we re-think docs
619 viewsНац Нац, 13:02
Открыть/Комментировать
2021-06-30 13:00:06
Подъехали результаты опроса по зарплатам Техписателей за 2020 год.

Читать: Write the Docs Salary Survey 2020 Results
532 viewsНац Нац, 10:00
Открыть/Комментировать
2021-06-29 16:55:23
Люблю честные чейнджлоги
733 viewsНац Нац, 13:55
Открыть/Комментировать
2021-06-29 16:37:34 Notion запустил Synced Blocks!

Вместо того, чтобы обновлять один и тот же кусок документа в миллионе мест, теперь можно создать Synced Block и ссылаться на него в любом другом месте, а изменения подтянутся :3

P.S

Ссылочка, собсно, на блогпост с историей формата, небольшим экскурсом в 60-е и ходом мысли по ходу разработки фичи
656 viewsНац Нац, edited  13:37
Открыть/Комментировать
2021-06-23 16:04:30 Мечтать не вредно, но и вредно не мечтать, или сказ об идеальных митингах.

Недавно я выкладывал пост про “Амазоновский Шестистраничник” (звучит как что-то из урбандикшнари, да), а теперь пришло время еще немного расширить границы познания о культуре документации в Amazon, ибо она крутая.

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

И в чем же секрет, спросите вы? Конечно же в чтении документации! Но ее и так читают, скажете вы? Как бы не так! Но тут речь идет о >document-based-митингах<, начинаются которые с (нет, вы только представьте) коллективного чтения документа.

В чем автор поста видит проблему обычных митингов:

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

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

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

И запомните, if there isn’t a doc there isn’t a meeting

Читать: The Document Culture of Amazon
511 viewsНац Нац, 13:04
Открыть/Комментировать
2021-06-16 16:47:56
Стоит ли использовать в документации обращение от первого лица множественного числа?

Навернка во время написания технической документации, у вас возникала мысль использовать: “we”, “us”, и “ours”. Но в отличие от второго лица (“you”), использование “we” не так явно распространено или приемлемо.

Но не все так просто! Статья углубляется в вопрос использования “we” и кроме того, автор сравнивает как разные стайлгайды советуют поступать с вот этим вот всем.

Читать: Should you use the first-person plural in your documentation?
486 viewsНац Нац, 13:47
Открыть/Комментировать
2021-06-09 18:10:09
Набрёл тут на советы для пишущих от Amazon (если кто знает, где взять фулл — напишите в комментариях).

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

Bonus Track:

Очень детальный рассказ о структуре “Амазононовского Шестистраничника”. Это Джефф Безос невзлюбил скучные паверпойнт презентации и заставил всех писать вразумительные, легкочитаемые и усвояемые narrative- и data-driven отчеты. Ну короче, как раз то, что нам с вами нужно.

Читать: The Anatomy of an Amazon 6-pager
496 viewsНац Нац, 15:10
Открыть/Комментировать
2021-06-07 15:47:49 Иногда нужно быстро “поиграться текстом” на уже запаблишеном материале, будь-то заголовок, подзаголовок или какая-то сноска. Что мы все делаем обычно в таком случае? Конечно же, идем в ДевТулзы браузера и ковыряем буквы там. Но, скажем честно, процесс не самый магический и завораживающий, поэтому от него хотелось бы отказаться в пользу чего-нить поудобнеé.

Наткнулся на приятный плагинчик для (извините пользователи Firefox) Chromium-based браузеров, который превращает любой текст в готовый для редактирования

Пользуйтесь на здоровье: Polishapp
580 viewsНац Нац, 12:47
Открыть/Комментировать
2021-05-31 14:31:38
Если вы только начали открывать для себя линтеры простого нашего с вами языка, то предлагаю к ознакомлению отличный интродакшн в Vale.

Объясняют и в чем отличие от линтеров кода, и этимологию самого слова, и даже делятся ссылочкой на Vale Studio, которой я совсем забыл с вами поделиться. Vale Studio это бесплатный веб-бейзд редактор, который позволяет легко создавать и тестировать новые правила. Очень тесно интегрирован с regex101.

Читать: First steps with the Vale prose linter
521 viewsНац Нац, edited  11:31
Открыть/Комментировать
2021-05-26 14:32:40
Всем привет!

Иксолла открыла прием заявок на направление Documentation в рамках Xsolla School 2021!

В этом году впервые организовано два потока:

– Базовый (количество участников не ограничено): для тех, кто хочет познакомиться с основными понятиями и принципами документации.

– Профильный (только 15 участников): для тех, кто уже знает основы работы с документацией и хочет прокачать профессиональные навыки.

На школе вы научитесь писать документацию, которую реально будут читать, начнете понимать особенности ГОСТов и стайлгайдов, узнаете специфику подготовки контента для UI/UX веб-приложений и многое другое!

Обучение в школе полностью бесплатное. Прочитать подробности и пройти регистрацию можно по ссылке: https://rb.gy/wftbg5
284 viewsНац Нац, 11:32
Открыть/Комментировать