Отличная подборка, отдельно плюсану Managing Technical Writers: она сильно расширяет сознание в плане высокоуровневого взгляда на процессы документирования

Добавлю от себя
Modern Technical Writing by Andrew Etter, очень небольшая и компактная, зашла

Спасибо)

На самом деле у Рика Гамильтона целое издательство XMLPress - и там много можно чего интересного почерпнуть.

Добрый день! Подскажите, "Программа и методика предварительных испытаний" и "Программа и методика опытной эксплуатации" - это один и тот же документ? Если нет, то в чем их кардинальные отличия и можно ли их объединять?

#wanted_tw
Компания: "CityAir" (Новосибирск, Академгородок), https://cityair.io/  
Наш продукт: система (программно-аппаратный комплекс) для экологического мониторинга атмосферного воздуха.
Наши сети мониторинга развернуты в нескольких городах России. Мы продолжаем развиваться в России и выходим на международный рынок.

Мы ищем технического писателя, прежде всего в команду разработки оборудования.
Главная задача: обеспечивать продукт всей необходимой документацией.

Предстоит работать со следующими типами документов: Паспорт, Руководство по эксплуатации, Этикетка, Технические условия, Инструкция по монтажу, Инструкция по ремонту, Монтажный шаблон, Описание типа средства измерения, Методика поверки.
В процессе работы Вы будете взаимодействовать с разработчиками, дизайнерами, подрядчиками
Нам интересны как классические бумажные документы, так и интерактивные пособия, видеоинструкции.

Что нужно делать:
• Разрабатывать документы;
• Внедрять документы в производство;
• Вести электронную базы документов;
• Поддерживать документацию в актуальном состоянии;
• Организовывать процесс разработки;
• Автоматизировать процесс разработки, внедрения, хранения документации.

Смирнов Роман, @SmirnovRomanN, +79137777416, smirnov-rn@cityair.io

Добрый день! Это разные документы, предназначенные для разных этапов приемки системы. Приемка обычно осуществляется в три этапа:
1. Предварительные испытания;
2. Опытная эксплуатация;
3. Приемочные испытания и ввод систему в эксплуатацию.
И состав у документов немного разный, можете найти шаблоны на эти документы по ГОСТ.

Может быть идентичный по структуре и тестам, только цели разные и места проверок, может варьироваться наборами тестов, в предварительных больше, например, чем при эксплуатации

Также на тему высокоуровневого взгляда на процессы документирования очень хороша книга Information Development by JoAnn T. Hackos. Ее последнее издание датируется 2006 годом, но информация по прежнему ценная и актуальная.

Хорошие вопрос который тоже меня интересует , вам удалось найти в какую сторону копать ?

Недавно прочитал книгу Structured Writing by Mark Baker от XML Press. Это тот же автор что написал Every Page is Page One. Обе книги загружены ценными идеями под завязку.

Абсолютно нет, все платные сервисы очень дорогие. У компании нет на это средств и даже скорее желаний чтобы такой архив делать.

в Git

GitHub/Gitlab бесплатные. Dropbox недорогой. Но внутри вашей папки... Либо настраивать шару (shared(samba) fileserver), либо можно какой-нибудь http/ftp file server настроить.

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

В том же гитлабе можно настроить уровни доступа, когда человек может смотреть проект, но не может коммитить ничего

Зависит от процессов внутри вашей компании. Настройки доступа всего лишь отражение этих процессов

Доброе утро👋
Разработка изделия находится на этапе опытного образца.
Элементно-компонентная база изделия выдерживает повышенную температуру 65 по Цельсию, мне нужна температура 85 (для конкурентоспособности).
Какой вид испытаний в таком случае проводят, чтобы документально подтвердить, что изделие на температуре 85 будет работоспособно.

Предварительные испытания.

Привет! Про «голос» и «тональность» продукта.
Никому не кажется, что это довольно неудачная калька?
По крайней мере, именно в такой терминологии сложно продать принципы стейкхолдерам и донести их до команды. А вот если заменить на «язык» и «интонацию» — сразу всем всё понятно.
Например, так «с бизнес-пользователями наш продукт говорит на профессиональном языке, используя партнёрские интонации, а с физлицами — на бытовом, с фамильярными интонациями.» Как-то так. Или нет?