writer (Все сообщения пользователя)

Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru! 
@twriters
 obmen_soobsheniyami.pngчат для технических писателей в Telegram

 Зарегистрируйтесь
Выбрать дату в календареВыбрать дату в календаре

Страницы: Пред. 1 2 3 4 5 6 7 След.
Как разработать документ "Техническое предложение", "Техническое предложение" разработка документа, все вопросы, советы по разработке, для технических писателей
 
Всем привет! Поступила мне такая задача: разработать документ "Техническое предложение" на автоматизированную систему (АСУ). Это, достаточно, популярная задача для технических писателей. Решил создать тему, где можно все это обсудить и решить что для этого нужно, с чего начать, какие документы пригодятся.
Собираем все вопросы по этой теме здесь
Копилка шаблонов для технического писателя
 
какого плана нужна помощь? Написать или подсказать как писать?
Копилка шаблонов для технического писателя
 
Что-то не совсем туда написали
Разработка технической документации, Разработка технической документации в соответсвии с ГОСТ
 
я тоже немного в шоке от таких требований))
Раздел данные проверки принятых решений на патентную чистоту и конкурентоспособность, Пример для пояснительной записки
 
Там описываются проведенные исследования на патентную чистоту. По конкурентноспособности, можете привести 2-3 программы похожего направления и сравнить, чем ваша программа (АСУ) лучше.
Одна настройка перекрывает другую - как правильно написать?, Помогите правильно подобрать термин
 
Подсказали в нашей группе : изменяются настройки по умолчанию
Help&Manual + SVN+ Subversion (опыт интеграции), Версионирование при помощи SVN, Изучение опыта по интеграции сервера Subversion
 
Коллеги, нам задавали вопрос (автор AGL, надеюсь он не против что мы восстановили вопрос) по опыту интеграцииHelp&Manual + SVN+ Subversion (опыт интеграции). $nj что может подсказать? Вопрос интересный, цитирую автора:

"Поддерживаю документацию для разрабатываемого нами ПО - 3 типа руководства на русском языке и 3 их аналога на английском языке. Хотя общая структура документов близка, оформление на английском языке отличается, поэтому можно говорить про 6 различных проектов. Готовые документы
сохраняются в SVN на сервере, с которой работают программисты, после чего происходит сборка.

 Чтобы упорядочить процесс создания документации, я локально установил Subversion сервер, Tortoise клиент и версионировал свои исходные файлы, из которых произвожу сборку PDF файлов на выходе. Я преследовал цели резервирования файлов, отслеживания внесенных изменений в журнале. Достигнутый
результат меня удовлетворяет.
 Репозиторий один, он содержит 6 проектов в папках поименованных по названию документов:(IMAGE: [URL=https://fotohosting.su/images/2019/07/22/KRANILISE.png]https://fotohosting.su/images/2019/07/22/KRANILISE.png[/URL]) (URL: [URL=https://fotohosting.su/images/2019/07/22/KRANILISE.png]https://fotohosting.su/images/2019/07/22/KRANILISE.png[/URL] )
 Стволовые файлы хранятся в директориях trunk. Планировал в директориях branches работать в процессе подготовки релизов ПО, а состояние документации на моменты релизов сохранять в директориях tags.

 Скажем, для версии 6 документация пишется в течение года, пока идет разработка и сертификация ПО, и процесс улучшения документов перманентный в свете исправления ошибок и обратной связи технической поддержки с клиентами. В то же время идет разработка 7 версии, которая существенно
отличается от 6 версии.
 Функционал описанный в документации 6 версии, должен быть описан и в 7 версии. Но отдельные исправления могут быть осуществлены только в 7 версии, а в 6 версии должны быть описаны костыли, помогающие выжить.


Вопрос.

 Можно ли организовать версионирование так, чтобы рабочие версии 7 сформировались на основе версии 6, а дальнейшая работа проходила независимо с версией 6 и версией 7, но при исправлении в 6 версии ошибок, характерных обеим версиям, существовала возможность простого слияния и только
в рамках конкретной ошибки (ничего лишнего)?"
Скриншоты с мобильных устройств
 
Привет!
Если еще актуально, волт такие предложения были в нашем @twriters чат для технических писателей в Telegram:

  1. При помощи фотоаппарата, перекачивать по USB и обрабатывать
  2. Я ставлю эмулятор мобильной ОС. И снимаю скрины обычными средствами типа SnagIT и т.д. По-моему - самый удобный и эффективный вариант
Help & Manual. Контроль версий
 
Вставка html-кода скорее всего может пригодится для вставки видео, картинки с сервера, вставки frame и т.д.
Описание информационного обеспечения системы
 
Ася! Спасибо! Вот это развернутый vipivka-smile  ответ!!
Описание информационного обеспечения системы
 
Вот так если кратко

Информационное обеспечение Системы включает совокупность информационного обеспечения, поставляемого разработчиком в рамках проекта, в том числе ряд справочников системы, а также совокупность данных, ввод которых осуществляется совместными силами рабочей группы (Функциональным заказчиком и Исполнителем).

Описание информационного обеспечения системы
 
Вот у нас здесь есть [URL=https://techwriters.ru/services/shablony/shablony-dokumentov-po-gost-34/shablon-opisanie-organizatsii-informatsionnoy-bazy-po-gost-34/]шаблон "Описание информационного обеспечения"[/URL] думаю, это то что Вам нужно
Описание информационного обеспечения системы
 
Если говорить про 34 ГОСТ то

В разделе "Состав информационного обеспечения" указывают наименование и назначение всех баз данных и наборов данных.

Базы данных – промышленные БД (MS SQL, Oracle, DB2 etc.)

Наборы данных – файлы (XML, CSV etc.)

Техписатель или аналитик, нормоконтролер, разработчик, руководитель проекта, Работа с государственным Заказчиком
 
Абсолютно такая же картина и это у всех. Ничего не понятно как будет реализовано, кто будет делать, а доки нужны)
Из преподавателей в техписы :)
 
Ничего не бойтесь, все у вас получится! Опыт хороший
Стили имиджей указываются в дюймах, "Мылят" картинки
 
По идее все верно, в пикселях. Что-то решили с "мылом"?
Объявлен конкурс на разработку стандартов для технических писателей, новые ГОСТы для разработки технической документации
 
Предложение от Веры Мишиевой пришло на нашу почту

[QUOTE]Было бы хорошо, если бы сами новые ГОСТы содержали все необходимые шаблоны документов, а не только бы описывали их.
[/QUOTE]
массовое переименование стилей в проектах
 
Firniara, спасибо за подробный ответ!
Копирование фрагментов чужих инструкций или ссылки на чужие инструкции?, Пользователи не любят ссылки на другие документы
 
[QUOTE]Firniara написал:
у нас такая логика - все что не относится к нашему ПО - смотрите гугл[/QUOTE]
Правильная позиция!
Объявлен конкурс на разработку стандартов для технических писателей, новые ГОСТы для разработки технической документации
 
Коллеги, есть возможность принять участие в разработке новых ГОСТов. Пишите в этой теме то, что Вы считаете нужным и обязательным в новых стандартах разработки технической документации. Это важно! Разработчики новых стандартов следят за темой и прислушаются к вашим советам. Спасибо!
Объявлен конкурс на разработку стандартов для технических писателей, новые ГОСТы для разработки технической документации
 
[URL=https://techwriters.ru/articles/razrabotka-tekhnicheskoy-dokumentatsii/nas-zhdut-novye-gosty-obyavlen-konkurs-na-razrabotku-novykh-standartov-dlya-razrabotki-tekhnicheskoy/]Нас ждут новые ГОСТы?[/URL]
РД 50-34.698-90, отмена РД -50, какие документы и стандарты взамен, что делать? Обсуждаем и спрашиваем
 
По идее, содержание документа теперь можно делать любым) :D
РД 50-34.698-90, отмена РД -50, какие документы и стандарты взамен, что делать? Обсуждаем и спрашиваем
 
Ох, пока все в шоке)

[URL=https://techwriters.ru/articles/razrabotka-tekhnicheskoy-dokumentatsii/proshchay-gost-rd-50-priznan-nedeystvuyushchim-rd-50-680-88-rd-50-34-698-90-i-r-50-34-119-90/]Новость об отмене РД-50[/URL]
Обновление сайта и форума
 
Всем привет! Был технический сбой, сайт был некоторое время недоступен.  help-smile

Сейчас все работает в штатном режиме. Приносим свои извинения! :oops:
С Днем Влюбленных!
 
Всем Любви и Счастья!

Пусть Любовь победит!


 
Страницы: Пред. 1 2 3 4 5 6 7 След.

Рейтинг@Mail.ru