techwriting

• https://t.me/twriters техрайтеры
• https://t.me/technicalwriters - и ещё техрайтеры.
• https://www.writethedocs.org/
• https://t.me/docops - про документацию, технические коммуникации, техномаркетинг и управление знаниями.
  • https://t.me/docsascode - их же чат
• https://www.reddit.com/r/technicalwriting/
• https://t.me/technical_writing (украинскоязычный канал)
• https://t.me/techwriters
• https://t.me/shut_up_and_write (канал)
• https://habr.com/ru/search/?q=%5B%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F%5D&target_type=posts&order=date
• https://habr.com/ru/search/?q=%5B%D1%82%D0%B5%D1%85%D0%BD%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B5%20%D0%BF%D0%B8%D1%81%D0%B0%D1%82%D0%B5%D0%BB%D0%B8%5D&target_type=posts&order=date
• https://zttl.space/t/asciidoc-i-doc-as-code/ - AsciiDoc и DocAsCode на форуме цеттельспейс.
  • https://docs.antora.org/antora/latest/ - рекомендованный там static site generator Antora.
  • https://t.me/foliantdocs - про Фолиант,
  • https://t.me/asciidoctor - любители AsciiDoctor.
• Про документирование по ГОСТ
  • https://habr.com/ru/post/122700/ Пишете Пояснительную записку к техпроекту (П2), куда включаете необходимый вам контент в виде разделов по РД50 и руководство пользователя по ГОСТ. Если у вас приложение сложное в обслуживании, сделайте еще Руководство администратора (отдельная книжечка). По сути это просто глава из РП, но так будет проще согласовывать. Заодно там будет минимально необходимый технический контент стадии РД (см. ГОСТ 34.602). Если заказчик вдруг запаникует и заговорит о ГОСТах, вы раздергаете контент П2 на отдельные «обеспечения» и все будет хорошо.
    1. По поводу «Чертежей формы документа (видеокадра)»: Очень полезный документ для визуализации/управления технологическими процессами, особенно когда согласован с технологами :) есть еще документ «Состав выходных данных (сообщений)», куда можно поместить все необходимые эскизы. Там же обычно живут и отчетные формы.
    2. По поводу «регламента работы службы эксплуатации»: он полностью вытекает из ПЗ, схемы функц. структуры и РЭ, иначе мы автоматизируем сферического коня в вакууме :) Часто приходится автоматизировать несуществующие бизнес-процессы. Чтобы опираться хоть на что-то, придумывается некий виртуальный бизнес-процесс, под который пишутся технические документы. Это ненормальная ситуация, но встречается сплошь и рядом. В нашей стране все еще свято верят в то, что с помощью хитрой программы можно решить проблемы бизнеса.

Другое дело, когда эту информацию предоставляет Заказчик в виде исходных данных, но это как договор составлен :)

1. ПЗ — это обычно самый ожидаемый и в итоге самый разочаровывающий документ, т.к. Исполнитель тупо запихивает в него ТЗ.

Сам стандарт морально устарел, но общая идея и методология актуальная до сих пор. Используя его, например совместно с ISO 15288 или 12207, вы получаете хороший инструмент.

• https://habr.com/ru/post/651331/ - про где найти и как проверить актуальность гостов.
• http://www.rugost.com

• http://habrahabr.ru/blogs/sysan4dummies/121169/ - про американский стандарт
• https://habr.com/ru/post/659191/
• https://habr.com/ru/company/orioninc/blog/565098/ - техрайтеры и Agile.
• https://habr.com/ru/post/549588/ - о доках для нужд команды.
• https://habr.com/ru/company/moysklad/blog/535230/ - а нафига и с какого момента начинать.

Рассчитываю подгрести постепенно всякое разбросанное абы где, что связано с тематикой.

• Из важного — эта работа не делается в одиночку. Потому что глаза замыливаются, «авторская слепота» мешает видеть свой текст. Кто-то пишет, кто-то вычитывает, меняться можно. А вот в одно лицо — очень и очень сложно.
• Дотошность, хороший язык, склонность структурировать информацию, хорошие отношения с техникой.
• Отметила у себя «профдеформацию»: по многим поводам сразу спрашиваю, можно ли это написать и повесить где-то на видном месте :)
• Кажется, и весь этот сайт-сад — одна большая «профдеформация». Создаётся из текста, размеченного легким языком разметки, хранится в git, часто обновляется, смысл его — систематизирование инфы по всякоразным темам, и я рада обратной связи :)
• https://classinform.ru/profstandarty/06.019-tekhnicheskii-pisatel-spetcialist-po-tekhnicheskoi-dokumentatcii-v-oblasti-informatcionnykh-tekhnologii.html - профстандарт.
  В нём мне, как ИП, интересно отнесение к видам экономической деятельности:
  • 62.0 - Разработка компьютерного программного обеспечения, консультационные услуги в данной области и другие сопутствующие услуги
  • 63.11 - Деятельность по обработке данных, предоставление услуг по размещению информации и связанная с этим деятельность
• https://digitalbroccoli.com/2021/07/06/techwriter-how-to/ - кто такие в ракурсе «хочу этим работать»
• https://developers.google.com/tech-writing/overview - гуглокурсы, 2шт
• https://stepik.org/course/684/promo#toc - английский + техрайтерство
• https://ru.wikipedia.org/wiki/%D0%A2%D0%B5%D1%85%D0%BD%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%B8%D0%B9_%D0%BF%D0%B8%D1%81%D0%B0%D1%82%D0%B5%D0%BB%D1%8C и https://ru.wikipedia.org/wiki/%D0%A2%D0%B5%D1%85%D0%BD%D0%B8%D1%87%D0%B5%D1%81%D0%BA%D0%BE%D0%B5_%D0%BF%D0%B8%D1%81%D0%B0%D1%82%D0%B5%D0%BB%D1%8C%D1%81%D1%82%D0%B2%D0%BE (вторая статья беднее и сильно пересекается с первой).

Всякое:

• https://habr.com/ru/company/plesk/blog/650779/ - про английский. Больше UX/UI, но не только.
• https://study.com/academy/course/technical-writing-course.html - англоязычный курс

Пробелы:

• http://new.gramota.ru/spravka/letters/78-init - надо ли ставить пробелы между инициалами и фамилией, между инициалами.
  • https://bureau.ru/bb/soviet/20110616/ - ещё о том же, и про уменьшенные пробелы.
• ГОСТ Р 7.0.97-2016 - Требования к оформлению документов - https://docs.cntd.ru/document/1200142871
• https://ru.wikipedia.org/wiki/Пробел
• https://ru.wikipedia.org/wiki/Википедия:Отбивка_знака_процента_от_предшествующей_цифры
  • https://docs.cntd.ru/document/1200031406 - ГОСТ 8.417-2002, там е про отбивание знака % пробелом.
• https://habr.com/ru/post/23250/ - выжимка из справочника Мильчина
  • https://orfogrammka.ru/%D1%81%D0%BF%D1%80%D0%B0%D0%B2%D0%BE%D1%87%D0%BD%D0%B8%D0%BA/%D1%81%D0%BF%D1%80%D0%B0%D0%B2%D0%BE%D1%87%D0%BD%D0%B8%D0%BA_%D0%B8%D0%B7%D0%B4%D0%B0%D1%82%D0%B5%D0%BB%D1%8F_%D0%B8_%D0%B0%D0%B2%D1%82%D0%BE%D1%80%D0%B0_%D0%BC%D0%B8%D0%BB%D1%8C%D1%87%D0%B8%D0%BD_%D1%87%D0%B5%D0%BB%D1%8C%D1%86%D0%BE%D0%B2%D0%B0/ - сам справочник