Формат документации

0 (0)
  • Развернуть Формат документации ( Королев Андрей  07.08.2003 14:22 )
    5(1)
    Для поставляемой в электронном виде документации существует огромное количество различных форматов. Doc (Word6/95), doc (Word 97), doc (Word 200/XP), rtf, pdf, djvu, ps, chm, hlp - перечислять можно долго. У каждого из форматов есть свои плюсы и свои минусы.

    Приведу пример: сейчас документация к комплексу InterBank существует в форматах pdf и rtf. Из положительных сторон формата pdf можно отметить его кроссплатформенность (документы можно просматривать как в Windows, так и в Unix и в MacOS). Из отрицательных сторон - сложность редактирования. Документы в формате rtf тоже можно просматривать на всех платформах и их достаточно просто редактировать, но размер документов просто ужасен (документ, занимающий в pdf около 2 Мбайт вырастает в rtf до 70 Мбайт).

    Данная тема предназначена именно для того, чтобы определить в каком формате должна включаться в дистрибутив документация по комплексу InterBank.
    Пожалуйста, сообщайте о ваших пожеланиях. Все предложения будут внимательно рассмотрены.
    >> Ответить
    • Развернуть Форматы и их задачи ( Ирина Лунёва  07.08.2003 15:54 )
      5(1)
      Формат PDF выполняет одну функцию, которая, насколько я понимаю, не может быть выполнена никаким иным способом. "Неудобство", а точнее, невозможность редактирования – это достоинство PDF. Дело в том, что все документы, предоставляемые пользователями, являются интеллектуальной собственностью Компании, и охраняются авторским правом. Информация об авторских правах Компании обязательно приводится на второй странице каждого документа.

      Но, согласитесь, вешать объявление "Просьба жуликам не входить!" на широко открытой двери – мягко говоря, нелогично. Т.к. документация на все программные продукты, равно как и сами программы, является собственностью Компании – сама Компания и должна позаботится о защите своих прав.

      Но при этом некоторые документы, действительно, поставляются в формате RTF. Это относится только к документам, предназначенным для пользователей клиентских подсистем, т.к. документацию по этим подсистемам необходимо дорабатывать сотрудникам банка в связи с особенностями технологии работы – увы, авторы Компании не в состоянии написать отдельный документ для каждого банка. При этом не столь важен объем файла – он скорее всего все равно будет после переработки переведен в другой формат; сколько важна многоплатформенность и возможность сохранения авторского форматирования.

      Я считаю, что использование именно этих форматов – PDF для основной документации и RTF для документации, дорабатываемой банком – оправданно и наиболее удобно.
      >> Ответить
      • Развернуть Имеет значение размер бумаги (+) ( Юрий Травкин  14.08.2003 09:51 )
        5(1)
        Сколько людей, столько мнений. Для меня важен размер бумаги.
        Документация размером A5 больше похожа на книгу, да и в руках
        её держать удобней.

        Предлагаю делать документацию в формате PDF под два размера бумаги:
        A4 и A5. Если документация в двух исполнениях это слишком,
        тогда пожалуйста A5.

        Не соглашусь с замечанием о невозможности редактирования документации
        в формате PDF.

        >> Ответить
        • Развернуть Формат бумаги ( Королев Андрей  14.08.2003 12:42 )
          5(1)
          Да, поскольку я уже более 3 лет работаю с разными издательствами (Символ-плюс, Cisco Press, Microsoft Press, ДМК, Питер, Русская Редакция) мне формат A5 тоже кажется более предпочтительным. Основное преимущество (кроме удобства и компактности печатной версии) - в этом формате можно выполнять спуск полос (когда на одном листе формата A4 печатаются сразу 4 страницы, а затем эти листы объединяются в брошюру - или в несколько при большом объеме документации). Однако для технологического процесса и электронной документации предпочтительнее формат A4.

          Поэтому можно предложить следующее решение: сначала выпускается документ в формате A4, используемый как электронный документ, а затем (примерно через две недели) делается "версия для печати" в формате A5.

          По поводу невозможности редактирования PDF - конечно PDF без защиты можно редактировать (да даже и с защитой есть способы). Кроме того, пароль для защиты от редактирования можно установить даже на файлы doc. В моем сообщении речь шла о том, что PDF труднее редактировать чем тот же RTF или DOC.

          Кроме того, я считаю что преимуществом документации является не "невозможность редактирования" (я не стремлюсь увековечивать свои ошибки), а "отсутствие необходимости редактирования".
          >> Ответить
          • Развернуть Версия для печати (+) ( Юрий Травкин  15.08.2003 03:44 )
            5(1)
            Сообщите, пожалуйста, на форуме о размещении на сервере в разделе
            "Техническая документация" первой документации в формате А5.

            Всегда с интересом относился к идее электронной документации.
            Хочу поделиться личными впечатлениями. Монитор 17" Sony Trinitron Multiscan E200.
            При чтении с экрана документации в Adobe Acrobat 4.0 более 1 часа утомляемость
            глаз выше, чем при чтении документации в Microsoft Word 2000. Размер шрифта
            приблизительно одинаковый.
            >> Ответить
            • Развернуть Новый формат ( Королев Андрей  15.08.2003 12:57 )
              5(1)
              Хорошо. В качестве эксперимента какой-нибудь из выходящих в ближайший месяц документов будет подготовлен в двух форматах (A4 и A5). Если новый формат окажется нужным клиентам, то дальнейшая документация также будет выпускаться в двух форматах.
              >> Ответить
          • Развернуть Версия для печати ( Roman Truschev  19.08.2003 09:26 )
            5(1)
            Возможно вы знаете, но могу предложить посмотреть программу FinePrint PDFFactory. Из любой программы печать в pdf, с возможностью печати брошюры. Печь на листе A4 четыре листа A5.
            >> Ответить