Вопрос: Как писать программную документацию?

 

Проектная документация. Рабочая документация. Отличия проектной и рабочей документации.

Видео взято с канала: PRO-Z: Проектирование зданий


 

24 Практика Проектная документация

Видео взято с канала: Александр Ряполов


 

Составление баг репортов

Видео взято с канала: QAмбридж — Об IT для тестировщика


 

Технический писатель: создание технической документации

Видео взято с канала: SpecialistTV


 

Лекция 1. Два определения технической документации.

Видео взято с канала: documentat.io


 

Почему техническая документация — это интересно

Видео взято с канала: Sam Faktorovich


 

Как писать полезные технические тексты

Видео взято с канала: Computer Science Center


7 комментариев

  • Классное объяснение, спасибо Сэм! Особенно мысль что тех документация это про экономию денег. Изначально я рассматривал эту тематику с точки зрения снижения рисков утери знаний. Это особенно актуально, когда ПО создаётся способом закупок у внешних программистов на аутсорсинге.

  • 2:18 Жанры технических тестов
    4:30 Руководство пользователя
    12:25 Туториал
    17:06 Справочное руководство(Reference)
    18:17 Сообщения в продукте
    21:25 Тексты в интерфейсе
    24:40 Продуктовые подсказки(Tips of the day)
    28:20 Спецификации
    29:23 База знаний
    31:24 Посты в блогах
    32:52 Форумы

  • О системе образования верно. Давно наблюдаю деградацию, и с печалью, сравнивая потом, системы образования, задним числом и имея выбор бы выбрал бы образование в вузе в Европе. Но увы такого выбора не было. Считаю что на уровне школы мы возможно опережаем Европу, но уже в институте, и далее аспирантура мы не сопоставимы и устарели. Думал о проблеме. Как один из вариантов патронаж отраслевых фирм, возможно градообразующих, за какие то возможно плюшки этим фирмам. Думаю начальнику отдела фирмы с штатом 1000 человек не сложно читать лекции старшим курсам, даже бесплатно. Но думаю не найти на каждую специальность такую фирму в городе. Мне повезло, у меня бвли преподаватели из научно производственной фирмы, и много профессоров бизнесменов, которые, кстати и читали лекции не по бумажке, и их было интересно слушать. Да и не скрывали что для них это не заработок, а хобби, максимум денег чтоб машину иногда заправлять, не более так прямо и говорили. Но таким отдавали кафедры, как людям с опытом, в обмен на должность и статус. Как сейчас выживают вузы, тоже не представляю…

  • Список тем в этом видео:

    00:00:26 Проектная документация

    00:00:40 384-ФЗ

    00:00:48 Основание для разработки проектной документации

    00:01:48 Почему в проекте могут потребовать сделать больше?

    00:02:35 Проблемы при сдаче проекта в экспертизу

    00:02:51 Чем грозит выигранный контракт?

    00:03:46 Как нужно проектировать гособъекты

    00:04:15 Разница между проектной и рабочей документацией

    00:06:46 Рабочая документация

    00:08:24 Что нужно прописывать в договоре на проектирование?

    00:09:47 Ответы на вопросы подписчиков
    Смотрите также на нашем канале:

    Интересный тип фундамента, который мало кто применяет, а зря: https://youtu.be/wHFgvUyHIRo

    Как сильно сэкономить на балка перекрытия в любом здании: https://youtu.be/st8uQFjXtj0

    Заказ проектов у нас по почте: pro-z69@bk.ru или на сайте pro-z.ru

  • С коллегой переходим на Теклу вот уже в течении полугода. Очень высокий порог входа. Чтобы сделать спецификацию нужно почти программирование знать. Для КМД она конечно незаменима. Но делать в ней КМ и КЖ сложнее автокада. Сейчас выигрыша в скорости нет, даже наоборот. Конечно плюсов в 3Д много, но дается это кропотливым трудом. Ни о каком 10-ти кратном увеличении производительности речи нет. Максимум раза в 2 при условии хорошего владения программой.

  • Спасибо большое за ваш труд по созданию видео! Отдельное спасибо,что делитесь своим потраченным временем и тонкими практическими моментами! Повод прописывать содержание и объем рабочей документации вызвал одновременно интерес и настороженность. В очередной раз благодарю вас за ваш труд!Продолжайте развивать ваш канал, ( реально круто и интересно),Удачи и Успехов!

  • БИМ любители это все бывшие студенты, которым в ревите понравилось работать больше, чем в автокаде. Хотя в автокаде они даже не научились хорошо и быстро чертить.

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

    И когда приходят к нам в фирму, то удивляются мол че мы за лохи и до сих пор в 2Д сидим…
    А когда просишь быстро начертить какой-нибудь узел и выдать чертеж в Ревите, то садятся в лужу. Но это я уже утрирую конечно)