Обнаружил и незамедлительно намазал свой VSCode оч красивым шрифтом с ублажающими очи лигатурами. Вы только полюбуйтесь! https://github.com/tonsky/FiraCode

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

https://medium.com/@jgee/what-i-learned-in-two-years-of-moving-government-forms-online-1edc4c2aa089

Немного о пользовательской документации

Копаться в документации к софту — зачастую катастрофа. На Хабре рассказали про главные проблемы пользовательской документации и как их исправить.

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

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

Круто-прикруто.

Mozilla релизнула свою систему (спецификацию, имплементацию и набор best practices) для "естественно звучащих" переводов. Потыкать можно на оф сайте, а почитать как там всё устроено и собсно зачем и почему это нужно - можно в официальном блоге Мозиллы или на wiki в GitHub.

Рекомендовано к ознакомлению, благое дело, подошли с умом.

О пользе чеклистов:

>Смертность после операций в Шотландии снизилась на 37% с 2008 года, что объясняется внедрением чеклиста безопасности.

https://www.bbc.com/news/uk-scotland-47953541

Документация? Документация!

Не болейте.

#checklist #en #article

https://chrome.google.com/webstore/detail/noncontiguous-text-select/ajbomhojbckleofgngogoecoaefclnol

Очень неплохо бы что-то нативное такое заиметь, пусть уже Apple "изобретёт" это у себя в очередной MacOS, чтобы другие к себе унесли через полгода. Такое надо.

Приятно знать, что не у одного меня горит от хреновых чейнджлогов больших приложений. Я понимаю, что там А/Б тесты, сервер-сайд фичи и что далеко не всем это нужно, и никто вообще их не читает, но это вообще не дело.
https://www.techwrap.net/tech/play-store-app-changelog-need-consistency/

В последнее время всё чаще и чаще вижу как многие перекатываются то на Gatsby, то на Hugo (причем не только для документации, но и для личных бложиков)

Вот отличная саксесс стори о переходе с богомерзкого Вордпресса на богоугодный Hugo

https://www.presslabs.com/how-to/documentation-hugo/

#SSG #en #article

Приятный и понятный гайд по ведению документации в Confluence.

Гайд покрывает такие темы как:
- Почему Confluence
- Создание топиков
- Коллаборация
- Переиспользование контента
- Версионирование
- Публикация
- Локализация
- Conditional контент

Кроме того, там лежит приятный док. процесс для Agile команд

Пользуйте!

https://www.k15t.com/rock-the-docs

На Season of Docs уже доступен список опенсорс проектов в которые можно контрибьютить документацию:

https://developers.google.com/season-of-docs/docs/participants/

#career #resource #en

Второй день не пойму related ли эта тема тут или нет, но я люблю буковки поэтому ловите.

Детальный и супер задротский разбор пресловутой PDF-ки Mueller Report. Там обсуждают PDF стандарты и их нарушение, выясняют как была создана эта пдф-ка и что пошло не так, а также софт которым цензурят такие документы и всякое такое. Всё это дело рассказывает дядька, который >ISO Project co-Leader for ISO 32000 (the PDF specification) and Project Leader for ISO 14289 (PDF/UA)

https://www.pdfa.org/a-technical-and-cultural-assessment-of-the-mueller-report-pdf/

#article

Немножко про организацию документации.

https://medium.com/@brooke.wayne/how-to-organize-your-docs-bd797c616b48

Статья описывает базовые вещи, но интересный тейкэвэй оттуда это термин Undernets:

>Undernets are the “non-formal and unintentionally walled off bits of knowledge that [folx] document in private”, also known as “rogue docs or sheets [others] create for themselves. These are often incorrect, out of date, or not shared with the entire team.”

#knowledgemanagement #resource #en

Для быстрых (как публичных, так и приватных) заметок поверх любой веб-странички (а также PDF и EPUB) пытаюсь пользоваться https://web.hypothes.is

Если вы плотно работаете над текстовкой какого-либо сайта/книги то вот это то, что нужно

#tool #en

Наткнулся тут на бложик техрайтера из Google, он пишет документацию для Chrome DevTools.

Очень понравилась оттуда статья про то, что может и не все бест практисы одинаково полезны (а может и полезны!) и применимы и размышления на счёт того, что со всей этой информацией нам делать и как измерять полезность конкретно взятой доки (солюшен очень прост и я с ним согласен)

https://kayce.basqu.es/blog/best-practices

Остальное тоже почитайте!

#resource #en #article

Анимированные презентации терминала. Можно экспортировать в SVG, GIF, или HTML+CSS

https://neatsoftware.github.io/term-sheets/

Вдруг пригодится.

#tool #visual #screenshot

Что бы вы выбрали?
anonymous poll

Go to File, and then select Save. – 49
👍👍👍👍👍👍👍 67%

Select Save from the File menu. – 24
👍👍👍 33%

👥 73 people voted so far.

⚡️⚡️⚡️

Свершилось! Один из самых гибких линтеров (Vale) вот-вот станет работать с sandboxed приложениями (читай Google Docs, Microsoft Word, Chrome)

https://medium.com/@jdkato/vale-comes-to-the-desktop-b813b24b66ba

#tool #testthedocs #en

На горизонте никаких интересных статеек, да и уже пятница, чо напрягаться.

Пусть и с запозданием, но вот хорошее пятничное чтиво от Increment про open-source, коммьюнити и иже с ними.

https://increment.com/open-source/

Вообще Increment отличное издание, советую подписаться и почитывать чем живут современные команды (RSS для понимающих)

#resource #article #en

Давненько в закладках лежит хороший разбор плюшек, которые предоставляют Docz, Storybook и Styleguidist для интерактивной документации UI-компонентов (и API'шек)

Кроме того, в статье хорошим и понятным языком рассказывают, что такое MDX

https://css-tricks.com/front-end-documentation-style-guides-and-the-rise-of-mdx/

#uiux #tool #en

Обновился до 4-й версии Markdown-редактор Inkdrop. Честно говоря, я уже совсем перестал обращать внимание на "специализированные" Markdown-редакторы, т.к ничем они друг от друга не отличаются и ужасно ограничены в наборе фукций. Но Inkdrop это исключение, ведь там есть плагины и даже полезные! До VSCode еще как до луны, но потенциал имеется, пробуйте.

#ide #en #markdown