Цифровой садик - приветственная

Цифровой садик - приветственная | Полный список всего, что тут есть | RSS | Подписаться через follow.it

23.06.2022

techwriting

Кто такие

Нужность обществу

  • 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/ - а нафига и с какого момента начинать.
  • https://habr.com/ru/post/665782/ - «Импортозамещение по советской модели. Выводы из ошибок будут сделаны?» - про сложности с обнаружением и передачей технологий. Про то, что происходит, если сохранение и передача знаний не налажены, в том числе даже обнаружение, что сохранять-то, но и что можно иначе ж.

    Что такое полноценная технологическая компетенция?

    1. Умение делать некий технологический процесс, т.е. наличие обученных данной технологии работников;
    2. Знание как делать этот технологический процесс, т.е. максимально подробное описание действий работников;
    3. Знание почему надо делать именно так этапы этого технологического процесса, а не иначе.

    Причём, перечисленные пункты находятся в неразрывной связи. Т.е. ущерб для одного из них неминуемо повлечёт деградацию двух других.

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

    Печалится о том, что исключения единичны и системой не поддерживаются. Такой вот выход на общественное, куда я эту ссылку тож добавила.

Некоторые места общения

Обучение

Писать по гостам

  • Про документирование по ГОСТ
    • https://habr.com/ru/post/122700/ Пишете Пояснительную записку к техпроекту (П2), куда включаете необходимый вам контент в виде разделов по РД50 и руководство пользователя по ГОСТ. Если у вас приложение сложное в обслуживании, сделайте еще Руководство администратора (отдельная книжечка). По сути это просто глава из РП, но так будет проще согласовывать. Заодно там будет минимально необходимый технический контент стадии РД (см. ГОСТ 34.602). Если заказчик вдруг запаникует и заговорит о ГОСТах, вы раздергаете контент П2 на отдельные «обеспечения» и все будет хорошо.
      1. По поводу «Чертежей формы документа (видеокадра)»: Очень полезный документ для визуализации/управления технологическими процессами, особенно когда согласован с технологами :) есть еще документ «Состав выходных данных (сообщений)», куда можно поместить все необходимые эскизы. Там же обычно живут и отчетные формы.
      2. По поводу «регламента работы службы эксплуатации»: он полностью вытекает из ПЗ, схемы функц. структуры и РЭ, иначе мы автоматизируем сферического коня в вакууме :) Часто приходится автоматизировать несуществующие бизнес-процессы. Чтобы опираться хоть на что-то, придумывается некий виртуальный бизнес-процесс, под который пишутся технические документы. Это ненормальная ситуация, но встречается сплошь и рядом. В нашей стране все еще свято верят в то, что с помощью хитрой программы можно решить проблемы бизнеса.

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

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

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

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

Правила работы с текстом и всякие проверялки

Docs as code

diagrams as code

Немножко про историю меня, пишущей обо всяком таком

Прочие ссылки


Если у вас есть мысли, комментарии, предложения или отклики по поводу этой страницы или этого цифрового сада в целом, напишите мне сообщение через Яндекс.Форму или на agnessa@agnessa.pp.ru. Мне ооочень интересно!

Задонатить.


An IndieWeb Webring 🕸💍