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

👋 @SuckMyNuts
Download Telegram
То же самое, но на русском —> http://www.opennet.ru/opennews/art.shtml?num=48569

#examples #ru
Там вышла новая версия Marked 2, ПРЕВЬЮВЕРА маркдауновской разметки. Пишете в Markdown в своем текстовом редакторе, а в соседнем окошке все красиво отрисовывается, экспортится, еще и темы красивые есть. К тому же, для текстовых джедаев, которые пользуются Scrivener — есть поддержка и его формата, что упрощает работу с гигантскими объемами текста. Чейгджлог тут http://marked2app.com/help/changelog.html, а качать вот тут http://marked2app.com/ (есть демо)

#markdown #en
Прозрачно и максимально доступно написанная (и переведенная к тому же на русский!) инструкция по Семантическому Версионированию от соучредителя GitHub https://semver.org/lang/ru/spec/v2.0.0.html

#versioning #en #ru
И один из >ЛУЧШИХ< мануалов которые я видел на эту тему. Красиво, практично, понятно даже младенцу. Стайлгайд по написанию самых-пресамых чейнджлогов. Берите на вооружение! https://keepachangelog.com/

#changelog
У Valve красивейше заредизайнился сайт и есть даже вакансия Писателя! https://www.valvesoftware.com/

#vacancy #en
Небольшой тизер будущей статейки. На выходе имеем SVG :3

#diagram #DocsAsCode
Небольшая шпаргалка-чеклист по созданию видео-инструкций. Примерно так и выглядел весь процесс на одной из прошлых работ. Не самое веселое занятие, but still.

#checklist #en
Испытываю некий трепет при изучении старых документов легендарных штук. Тут максимально аналоговая документация Sonic the Hedgehog 2. Тасклист, рассчет коллизий c окружением и анимация бурления лавы.

#vintage #en
Абсолютно никак не могу понять, зачем создают вот такие https://danmoop.github.io/plume/ проекты. И тысячи их на всяких producthunt, 3.5 базовых фичи для написания текста, одна более-мене уникальная и все. Просто окошко для набора текста. Остановитесь, пожалуйста.

#ide #en
Хороший пример подачи документации в IKEA-стиле, в виде картинок/комиксов https://code-cartoons.com/

#example #en