Перейти к содержанию

Система подготовки технической документации

Материал из Etersoft wiki

Материал со старого сайта etersoft.ru, опубликован 12 ноября 2004 года.

О проекте

В нашей компании разработана система подготовки технической документации (СПД), которая позволяет оформлять текстовую документацию согласно ГОСТ 2.105-95 "Общие требования к текстовым документам".

Предлагаемая система используется в ряде научных и проектных организаций и формируемые в ней документы неоднократно проходили нормоконтроль.

Мы открыты для сотрудничества и предлагаем работать вместе над внедрением, расширением и улучшением нашей системы: ввести в строй на вашем предприятии, доработав с учётом специфики вашей деятельности.

Усилиями сообщества был создан ресурс с текущими наработками в области подготовки документации на свободном ПО: http://ppg.ice.ru/ppg/latex-gost/def_allmaterials. Имеется список рассылки для обсуждения текущих вопросов: latex-gost@ice.ru.

Основные отличия данной СПД

  1. Для работы с документами используется процессор документов LyX;
  2. Для предпечатной подготовки используется издательская система LaTeX;
  3. Требования стандарта заложены в класс lyxgost, строго соблюдающий требования ГОСТ;
  4. Имеется документация на русском языке;
  5. Поддерживается групповая работа и составные документы;
  6. В качестве основного выходного формата используется PDF как стандарт де-факто на промышленную документацию;
  7. Имеются подготовленные шаблоны документов;

Кому это нужно

Мотивы перехода на СПД:

  1. Решение проблем, возникающих при использовании обычных редакторов:
    • нестабильность работы при использовании сложных таблиц;
    • риск потери данных при работе с большими документами;
    • недолговечность хранения в архиве (связано с тем, что формат хранения данных коммерческих текстовых редакторов как правило засекречен и меняется с каждой новой версией программы).
  2. Необходимость стандартизации (утверждение корпоративного стандарта на используемые программы и форматы): единый источник для электронной и бумажной документации.
  3. Использование перспективной платформы Линукс — стабильной и безопасной, свободной от вирусов.
  4. Наличие коммерческой поддержки предлагаемого решения: обновление версий, консультации.
  5. Экономический мотив, связанный со стоимостью лицензирования ПО.

Особенности использования СПД

  1. Необходимость адаптации к новой, хотя и похожей на привычную, операционной системе.
  2. Импорт входящих документов из разных форматов (MS Word) и экспорт (в MS Word). При импорте и экспорте сохранение оформления документа не может быть обеспечено.

Преимущества использования СПД

  1. Хранение архивов документов в формате PDF гарантирует неизменность (с дополнительной подписью ключом).
  2. Стабильность работы, открытый формат, минимизирующий потери данных при возможном сбое.
  3. Возможность использование всех механизмов автоматизации, накопленных в Linux-дистрибутиве.
  4. Возможность неограниченных доработок свободных программ, входящих в цепочку СПД.
  5. Многоплатформенность клиентской части СПД.

Примеры оформления документации

На старом сайте были выложены примеры документов, подготовленных в данной СПД (файлы не сохранились):

  • пример оформления документации: example.pdf (PDF, 700 КБ), текст в формате LyX и иллюстрации: example-lyx.zip (900 КБ);
  • пример использования в научной работе (рефераты, дипломы): ref_gurv.pdf (PDF, 310 КБ), текст в формате LyX: ref_gurv.zip (11 КБ).

Подробнее

LaTeX позволяет запрограммировать большинство правил оформления текста, в том числе и оформления текстовой документации согласно ГОСТ. Уже готова первая версия класса ГОСТ для LyX, выведенная по каждому пункту "Общих требований к текстовым документам". Теперь каждый сможет работать над документацией, не изучая досконально ГОСТ'ы и не переделывая полностью документ после посещения нормоконтроля. Просто будет очень сложно написать что-либо не по ГОСТ'у.