techwriting

• 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://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://t.me/twriters техрайтеры
• https://t.me/technicalwriters - и ещё техрайтеры.
• 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://developers.google.com/tech-writing/overview - гуглокурсы, 2шт
• https://stepik.org/course/684/promo#toc - английский + техрайтерство
• https://starkovden.github.io/index.html - вольный перевод курса Documenting APIs: a guide for technical writers (https://idratherbewriting.com/learnapidoc/), составленного Томом Джонсоном, техническим писателем Amazon). Переводчик - @starkovden (tg, github). …разберете API на составные части, узнаете о конечных точках, параметрах, типах данных, аутентификации, curl, JSON, командной строке, консоли разработчика Chrome, JavaScript и прочих деталях, связанных с REST API.
  Модули курса:
  • Введение в REST API (https://starkovden.github.io/about-first-module.html)
  • Используем API как разработчики (https://starkovden.github.io/about-second-module.html)
  • Документирование конечных точек (https://starkovden.github.io/about-third-module.html)
  • Спецификация OpenAPI и Swagger (https://starkovden.github.io/about-fourth-module.html)
  • Тестирование документации (https://starkovden.github.io/about-fifth-module.html)
  • Концептуальные разделы (https://starkovden.github.io/about-sixth-module.html)
  • Публикация документации (https://starkovden.github.io/about-seventh-module.html)
  • Работа технического писателя (https://starkovden.github.io/about-eigth-module.html)
  • Нативные библиотеки API (https://starkovden.github.io/about-ninth-module.html)
  • Глоссарий API и источники (https://starkovden.github.io/about-tenth-module.html)
  • Документирование кода (https://starkovden.github.io/about-eleventh-module.html)
• Английский:
  • https://habr.com/ru/company/plesk/blog/650779/ - про английский. Больше UX/UI, но не только.
  • https://study.com/academy/course/technical-writing-course.html - англоязычный курс
• https://developers.google.com/tech-writing/overview
  • https://developers.google.com/tech-writing/accessibility
  • https://developers.google.com/tech-writing/announcements - расписание.

• Про документирование по ГОСТ
  • 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/ - про американский стандарт

зированных систем и программных продуктов в соответствии с требованиями ГОСТ 34. Структура и содержание документа + шаблоны в формате Microsoft Word (*docx)

• http://technicaldocs.ru/%D0%B3%D0%BE%D1%81%D1%8234 - содержит государственные стандарты, руководящие документы и другую нормативную документацию серии ГОСТ 34, а также шаблоны документов по ГОСТ 34.
  • http://technicaldocs.ru/%D0%B3%D0%BE%D1%81%D1%8234/%D1%88%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD%D1%8B шаблоны основных документов, разрабатываемых при документировании автомати
    • http://technicaldocs.ru/%D0%B3%D0%BE%D1%81%D1%8234/%D1%88%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD%D1%8B/%D1%80%D1%83%D0%BA%D0%BE%D0%B2%D0%BE%D0%B4%D1%81%D1%82%D0%B2%D0%BE_%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F
  • http://technicaldocs.ru/%D0%B3%D0%BE%D1%81%D1%8234/%D0%BD%D0%BF%D0%B0/%D1%80%D0%B450-34.698-90 Методические указания «Информационная технология. Комплекс стандартов и руководящих документов на автоматизированные системы. Автоматизированные системы. Требования к содержанию документов»
  • http://technicaldocs.ru/%D0%B3%D0%BE%D1%81%D1%8234/%D0%BD%D0%BF%D0%B02/%D0%B3%D0%BE%D1%81%D1%822.105-95
• http://technicaldocs.ru/%D0%B3%D0%BE%D1%81%D1%8219

• https://t.me/docops - про документацию, технические коммуникации, техномаркетинг и управление знаниями.
  • https://t.me/docsascode - их же чат
• https://zttl.space/t/asciidoc-i-doc-as-code/ - AsciiDoc и DocAsCode на форуме цеттельспейс.
• https://t.me/asciidoctor - любители AsciiDoctor.
• static site generators (и эта тема тоже интересовала меня задолго до осознания себя техрайтером).
  • https://t.me/technicalwriters/91259 - тут старт очередного разговора о генераторах статических сайтов с перечислением того, что людям заходило. Знакомые мне Nikola и jekyll тоже упомянуты были.
    • https://www.sphinx-doc.org/en/master/usage/markdown.html
    • https://foliant-docs.github.io/docs/
      • https://t.me/foliantdocs - про Фолиант,
    • https://docs.antora.org/antora/latest/ - Antora.
    • https://squidfunk.github.io/mkdocs-material/
    • https://docusaurus.io/ - ssg на React, доки пишутся на Markdown. Умеет всё, что и все, но ещё поддерживает MDX и React-комоненты (https://docusaurus.io/docs/markdown-features/react). Если дружите с React, можно делать классные интерактивные штуки в документах.

• Из важного — эта работа не делается в одиночку. Потому что глаза замыливаются, «авторская слепота» мешает видеть свой текст. Кто-то пишет, кто-то вычитывает, меняться можно. А вот в одно лицо — очень и очень сложно.
• Дотошность, хороший язык, склонность структурировать информацию, хорошие отношения с техникой.
• Отметила у себя «профдеформацию»: по многим поводам сразу спрашиваю, можно ли это написать и повесить где-то на видном месте :)
• Кажется, и весь этот сайт-сад — одна большая «профдеформация». Создаётся из текста, размеченного легким языком разметки, хранится в git, часто обновляется, смысл его — систематизирование инфы по всякоразным темам, и я рада обратной связи :)
  • https://agnessa.pp.ru/computer/emacs/20210619151424-projectile.html
  • https://agnessa.pp.ru/computer/20210801073251-find.html
  • https://agnessa.pp.ru/computer/emacs/20200820161313-org_drill.html
  • https://agnessa.pp.ru/computer/20201113191924-lilypond.html
  • https://agnessa.pp.ru/computer/emacs/20210823085256-mpv_el.html
  • https://agnessa.pp.ru/computer/emacs/20210731142039-org_static_blog.html
  • https://ladycat.wordpress.com/2019/08/04/xwrits-%d0%b8%d0%bb%d0%b8-%d0%ba%d0%b0%d0%ba-%d0%bd%d0%b0%d0%bf%d0%be%d0%bc%d0%bd%d0%b8%d1%82%d1%8c-%d1%81%d0%b5%d0%b1%d0%b5-%d0%be-%d0%bf%d0%b5%d1%80%d0%b5%d1%80%d1%8b%d0%b2%d0%b0%d1%85/
  • https://ladycat.wordpress.com/2017/01/14/recoll-t-%d0%b4%d0%b5%d1%81%d0%ba%d1%82%d0%be%d0%bf%d0%bd%d1%8b%d0%b9-%d0%bf%d0%be%d0%b8%d1%81%d0%ba%d0%be%d0%b2%d0%b8%d0%ba-%d0%b2-%d0%ba%d0%be%d0%bd%d1%81%d0%be%d0%bb%d0%b8/
  • https://ladycat.wordpress.com/2017/01/13/notmuch-%d0%b8%d0%bb%d0%b8-%d1%83%d0%b4%d0%be%d0%b1%d0%bd%d0%b0%d1%8f-%d0%bf%d0%be%d1%87%d1%82%d0%b0-%d0%b2-emacs/ и https://agnessa.pp.ru/20210916+/20211218184142-notmuch.html
  • https://ladycat.wordpress.com/2017/01/12/%D0%B0%D0%B2%D1%82%D0%BE%D0%B8%D0%B7%D0%B1%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D0%BE%D1%82-%D1%83%D0%B6%D0%B5-%D0%BD%D0%B5%D0%BD%D1%83%D0%B6%D0%BD%D1%8B%D1%85-%D0%B1%D1%83%D1%84%D0%B5%D1%80/
  • https://ladycat.wordpress.com/2017/01/07/%d0%bd%d0%b8%d0%ba%d0%be%d0%bb%d0%b0-%d0%ba%d0%b0%d0%ba-%d1%81%d0%b4%d0%b5%d0%bb%d0%b0%d1%82%d1%8c-%d1%81%d0%b0%d0%b9%d1%82-%d0%b0-%d0%bd%d0%b5-%d0%b1%d0%bb%d0%be%d0%b3/
  • https://ladycat.wordpress.com/2017/01/02/djvu/, https://agnessa.pp.ru/20220101/20220118151628-djvu.html
  • https://ladycat.wordpress.com/2013/03/13/dict_n_dictem_n_emacs/
  • https://ladycat.wordpress.com/2011/01/26/perl_convert_entities/
  • https://ladycat.wordpress.com/2011/01/12/agenda_to_script/
  • https://ladycat.wordpress.com/2010/12/12/spaced_repetition_mnemosyne/
  • https://ladycat.wordpress.com/2010/12/09/fdupes_xargs_rm_find/

• https://www.writethedocs.org/
• https://habr.com/ru/hub/technical_writing/
  • 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://en.wikipedia.org/wiki/ROBODoc - премилая штука, которую я применяла для своих мелкоскриптиков.
  • https://rfsber.home.xs4all.nl/Robo/index.html - их собственный сайт.
• https://t.me/alliancepro - айти- и медпереводы - как употребляются слова, как строятся фразы…
• emacs для прозы
• linters for text
• скриншотилки
• памятка по русскому языку