Коллеги, ищу шаблон для Latex по ГОСТ 19 и 34. Предлагаю если есть, то поделится и выложим на сайте TechWriters.ru
Слетела верстка для Интернет Эксплоера (IE) Форум и сайт отображается "коряво". Проверить все браузеры
Поступил я, стало быть, на должность тех.писа в одну из крупнейших IT компаний. Поступило задание запилить инструкцию пользователя программным продуктом. С нюансами профессии я ещё незнаком, но до этого курил требования ГОСТов и работал по инженерной специальности, правда совершенно в другой области.
Ну взялся за всё это дело с огромным рвением, учитывая, что срок "Вчера" очень сильно мотивирует. Не буду уточнять степень намыленности разных частей тела, думаю, что и сами понимаете.
Вообщем запилил я три варианта инструкций, далее поступило указание оформить их в виде отдельных статей.
Подключил инструментарий по обработке скриншотов, создал стиль документа. И вот что я надумал...
ИДЕЯ такова - при создании документа, в целях его единообразия в плане оформления, вставлять скриншоты фиксированного формата. Т.е. не обязательно лепить весь экран в документ. ну и отдельным списком делать описание элементов, и действий оператора (пользователя). При создании скриншотов, юзал Dr.Explain.
Если есть критика/советы/опыт работы в данном аспекте - - буду рад ознакомиться с вашими тезисами
Ну взялся за всё это дело с огромным рвением, учитывая, что срок "Вчера" очень сильно мотивирует. Не буду уточнять степень намыленности разных частей тела, думаю, что и сами понимаете.
Вообщем запилил я три варианта инструкций, далее поступило указание оформить их в виде отдельных статей.
Подключил инструментарий по обработке скриншотов, создал стиль документа. И вот что я надумал...
ИДЕЯ такова - при создании документа, в целях его единообразия в плане оформления, вставлять скриншоты фиксированного формата. Т.е. не обязательно лепить весь экран в документ. ну и отдельным списком делать описание элементов, и действий оператора (пользователя). При создании скриншотов, юзал Dr.Explain.
Если есть критика/советы/опыт работы в данном аспекте - - буду рад ознакомиться с вашими тезисами
Нужен раздел на сайте, куда можно было бы добавлять:
- ключевые ГОСТы и международные стандарты,
- тематические словари, словари компьютерных терминов,
- описание элементов пользовательских графических интерфейсов различных компиляторов,
- анкеты-опросники на предмет различных предметных областей,
- перечень программного обеспечения как рабочих инструментов технического писателя,
- библиотеку иконок,
- классификаторы,
- шаблоны документов,
- и т.п
- ключевые ГОСТы и международные стандарты,
- тематические словари, словари компьютерных терминов,
- описание элементов пользовательских графических интерфейсов различных компиляторов,
- анкеты-опросники на предмет различных предметных областей,
- перечень программного обеспечения как рабочих инструментов технического писателя,
- библиотеку иконок,
- классификаторы,
- шаблоны документов,
- и т.п
Одно из приоритетных направлений любого производства в рамках системы управления качеством, которую предписывает ГОСТ /Р ИСО 9001, это управление записями. Разработка внутренних корпоративных стандартов в организациях далеко не ушла от предписаний ГОСТ по оформлению инженерной документации. В своей работе технический писатель руководствуется многими стандартами, выполняет работу по творческому написанию текста документа, проводит интервью с различными специалистами относительно предмета описания, специалистами, которые вовлечены в разработку технических устройств, автоматизированных систем и программного обеспечения в составе этих систем. Однако на плечи технического писателя возлагаются обязанности по вёрстке электронных документов и брошюровки этих документов на бумажных носителях. MS Word предоставляет широкие возможности по подготовке документов от вёрстки до получения статистических сведений по документу.
Пути вёрстки документа в MS Word различны:
- Использование эталонного документа (шаблона, файл с расширением dot).
- Использование обычного документа, взятого за образец.
Скорость создания документа может быть увеличена, если на большом экране монитора параллельно в разных окнах MS Word расположить редактируемый документ и документ, взятый за образец, но такой подход не всегда идёт на пользу из-за того, что приходится масштабировать документ на экране монитора.
Да и сам процесс вёрстки связан с рядом рутинных операций:
- создание раздела,
- обработка в разделе текста и заголовка,
- определение типа заголовка,
- добавление нумерации страниц,
- добавление рамки,
- формирование текста "Содержания",
- формирование листа "Составлено",
- применение стиля текста раздела,
- обработать рисунки,
- добавить информацию о документе,
- сформировать имя файла,
- создание раздела списка сокращений,
- формирование децимального номера, если он нужен,
- и т.п.
Предлагается разработать надстройку к MS Word, которая бы упростила бы выполнение этих операций.
ПОЛЬЗОВАТЕЛЬСКИЙ ИНТЕРФЕЙС
Действия
- Зарегистрировать
- Выполнить регистрацию
- Заполнить поля свойств документа
- Внести ФИО в документе
o - Изменения в Лист утверждения
o - Изменения в Лист составителей
- Установить параметры импорта
- Отформатировать
- В стиле ЕСКД
- В стиле ЕСПД
- В заданном стиле 1
- В заданном стиле 2
- Оформить колонтитулы
- Обновить связанные поля
- Добавить рамку
o - В стиле ЕСКД
o - В стиле ЕСПД
o - В заданном стиле 1
o - В заданном стиле 2
- Удалить рамку
o - В стиле ЕСКД
o - В стиле ЕСПД
o - В заданном стиле 1
o - В заданном стиле 2
- Удалить все колонтитулы
Структура
- Задать структуру
- Состав частей документа
- Порядок следования в основной части
- Добавить в структуру
- Удалить из структуры
- Титульная часть
o Лист утверждения
o Титульный лист
- Информационная часть
o Аннотация
o Лист содержания
- Основная часть
o Текст документа;
o Приложения;
o Перечень терминов;
o Перечень сокращений;
o Перечень рисунков;
o Перечень таблиц;
o Предметный указатель;
o Перечень ссылочных документов;
o Перечень символов и числовых коэффициентов;
o Часть регистрации изменений;
- Лист составителей
- Лист регистрации изменений
- Вставить название раздела
На рисунке ниже приводится общий алгоритм по подготовке документа.

Ищутся энтузиасты, команда которых бы взялась за разработку такой надстройки. В наличии имёются блок-схемы процессов около 16 штук.
Пути вёрстки документа в MS Word различны:
- Использование эталонного документа (шаблона, файл с расширением dot).
- Использование обычного документа, взятого за образец.
Скорость создания документа может быть увеличена, если на большом экране монитора параллельно в разных окнах MS Word расположить редактируемый документ и документ, взятый за образец, но такой подход не всегда идёт на пользу из-за того, что приходится масштабировать документ на экране монитора.
Да и сам процесс вёрстки связан с рядом рутинных операций:
- создание раздела,
- обработка в разделе текста и заголовка,
- определение типа заголовка,
- добавление нумерации страниц,
- добавление рамки,
- формирование текста "Содержания",
- формирование листа "Составлено",
- применение стиля текста раздела,
- обработать рисунки,
- добавить информацию о документе,
- сформировать имя файла,
- создание раздела списка сокращений,
- формирование децимального номера, если он нужен,
- и т.п.
Предлагается разработать надстройку к MS Word, которая бы упростила бы выполнение этих операций.
ПОЛЬЗОВАТЕЛЬСКИЙ ИНТЕРФЕЙС
Действия
- Зарегистрировать
- Выполнить регистрацию
- Заполнить поля свойств документа
- Внести ФИО в документе
o - Изменения в Лист утверждения
o - Изменения в Лист составителей
- Установить параметры импорта
- Отформатировать
- В стиле ЕСКД
- В стиле ЕСПД
- В заданном стиле 1
- В заданном стиле 2
- Оформить колонтитулы
- Обновить связанные поля
- Добавить рамку
o - В стиле ЕСКД
o - В стиле ЕСПД
o - В заданном стиле 1
o - В заданном стиле 2
- Удалить рамку
o - В стиле ЕСКД
o - В стиле ЕСПД
o - В заданном стиле 1
o - В заданном стиле 2
- Удалить все колонтитулы
Структура
- Задать структуру
- Состав частей документа
- Порядок следования в основной части
- Добавить в структуру
- Удалить из структуры
- Титульная часть
o Лист утверждения
o Титульный лист
- Информационная часть
o Аннотация
o Лист содержания
- Основная часть
o Текст документа;
o Приложения;
o Перечень терминов;
o Перечень сокращений;
o Перечень рисунков;
o Перечень таблиц;
o Предметный указатель;
o Перечень ссылочных документов;
o Перечень символов и числовых коэффициентов;
o Часть регистрации изменений;
- Лист составителей
- Лист регистрации изменений
- Вставить название раздела
На рисунке ниже приводится общий алгоритм по подготовке документа.

Ищутся энтузиасты, команда которых бы взялась за разработку такой надстройки. В наличии имёются блок-схемы процессов около 16 штук.
Во-первых, получается очень мелкий текст.
Во-вторых, некоторые ссылки, строки и картинки либо выходят за границу, либо визуально обрезаются.
Что не есть удобно в обоих случаях
Сейчас стоит ширина 948px, нужно хотябы 1300. Или поставить body=100%, а данный див 66,6% (это 2/3) от body.
Во-вторых, некоторые ссылки, строки и картинки либо выходят за границу, либо визуально обрезаются.
Что не есть удобно в обоих случаях
Сейчас стоит ширина 948px, нужно хотябы 1300. Или поставить body=100%, а данный див 66,6% (это 2/3) от body.
Добавить возможность загрузки файлов на форум
Поменять цвет текста на форуме на черный т.к плохо видно
Эта идея такая замечательная!
Вот такая интересная идея у меня есть! Кто за?