Размер шрифта
Цвет фона и шрифта
Изображения
Озвучивание текста
Обычная версия сайта
Tehpis.ru: Разработка технической документации, статей и публикаций
8 (812) 920-85-37
8 (812) 920-85-37
E-mail
zakaz@tehpis.ru
Адрес
194100, г. Санкт-Петербург, Лесной проспект 64 литера А пом 1-Н
Главная
О компании
  • О компании
  • Новости
  • Контакты
Услуги
  • Отчетная документация по НИР, ОКР, НИОКР
    • Что такое НИР, ОКР, НИОКР
    • Инициативная разработка продукции
    • Проведение испытаний и изготовление опытного образца
    • Этапы выполнения опытно-конструкторской работы
  • Оформление паспорта оборудования
  • Разработка документации на автоматизированные системы
    • Разработка документации на автоматизированные системы
    • Стадии создания автоматизированных систем
    • Опытная эксплуатация
  • Разработка конструкторской документации
    • ГОСТы ЕСКД скачать
    • Особенности разработки конструкторской документации:
    • Виды и комплектность конструкторской документации
    • ЕСКД история возникновения
    • Разработка чертежей
    • Оформление КД для иностранных заказчиков
  • Разработка обоснования безопасности
    • Роль разработки обоснования безопасности на опасных производственных объектах
    • Что включают в себя требования к надежности производственного оборудования при разработке обоснования безопасности
  • Разработка программной документации
    • Разработка руководства оператора
    • Разработка руководства системного программиста
    • Стадии и этапы разработки программной документации
    • Виды программных документов
    • ГОСТы ЕСПД скачать
    • Документация для ПО по ГОСТ
    • Программная документация и ее разновидности
  • Разработка руководства по эксплуатации
    • Признаки грамотно составленного руководства по эксплуатации оборудования
    • Интерактивные руководства. Что такое ИЭТР, классы ИЭТР.
    • Разработка видеоруководств
  • Разработка технических заданий
    • Как формируются требования при составлении технического задания
    • Основные ошибки при разработке технического задания и как их избежать
    • Пишем статью
    • Разработка технического задания на ПО
    • Что такое техническое задание и как его разрабатывать
  • Разработка технических условий
  • Разработка технологической инструкции
    • Виды технологической документации
    • Стадии разработки технологической документации
    • Единая система технологической документации
  • Документация для сертификации оборудования
    • Для чего проводится сертификация продукции, какие необходимы документы
Примеры работ
  • Конструкторская документация
  • 3D моделирование, визуализация
  • Документация для сертификации оборудования
  • Документация на автоматизированные системы
  • Программная документация
  • Технические задания
Информация
Контакты
8 (812) 920-85-37
8 (812) 920-85-37
E-mail
zakaz@tehpis.ru
Адрес
194100, г. Санкт-Петербург, Лесной проспект 64 литера А пом 1-Н
Tehpis.ru: Разработка технической документации, статей и публикаций
Главная
О компании
  • О компании
  • Новости
  • Контакты
Услуги
  • Отчетная документация по НИР, ОКР, НИОКР
    • Что такое НИР, ОКР, НИОКР
    • Инициативная разработка продукции
    • Проведение испытаний и изготовление опытного образца
    • Этапы выполнения опытно-конструкторской работы
  • Оформление паспорта оборудования
  • Разработка документации на автоматизированные системы
    • Разработка документации на автоматизированные системы
    • Стадии создания автоматизированных систем
    • Опытная эксплуатация
  • Разработка конструкторской документации
    • ГОСТы ЕСКД скачать
    • Особенности разработки конструкторской документации:
    • Виды и комплектность конструкторской документации
    • ЕСКД история возникновения
    • Разработка чертежей
    • Оформление КД для иностранных заказчиков
  • Разработка обоснования безопасности
    • Роль разработки обоснования безопасности на опасных производственных объектах
    • Что включают в себя требования к надежности производственного оборудования при разработке обоснования безопасности
  • Разработка программной документации
    • Разработка руководства оператора
    • Разработка руководства системного программиста
    • Стадии и этапы разработки программной документации
    • Виды программных документов
    • ГОСТы ЕСПД скачать
    • Документация для ПО по ГОСТ
    • Программная документация и ее разновидности
  • Разработка руководства по эксплуатации
    • Признаки грамотно составленного руководства по эксплуатации оборудования
    • Интерактивные руководства. Что такое ИЭТР, классы ИЭТР.
    • Разработка видеоруководств
  • Разработка технических заданий
    • Как формируются требования при составлении технического задания
    • Основные ошибки при разработке технического задания и как их избежать
    • Пишем статью
    • Разработка технического задания на ПО
    • Что такое техническое задание и как его разрабатывать
  • Разработка технических условий
  • Разработка технологической инструкции
    • Виды технологической документации
    • Стадии разработки технологической документации
    • Единая система технологической документации
  • Документация для сертификации оборудования
    • Для чего проводится сертификация продукции, какие необходимы документы
Примеры работ
  • Конструкторская документация
  • 3D моделирование, визуализация
  • Документация для сертификации оборудования
  • Документация на автоматизированные системы
  • Программная документация
  • Технические задания
Информация
Контакты
    Tehpis.ru: Разработка технической документации, статей и публикаций
    Главная
    О компании
    • О компании
    • Новости
    • Контакты
    Услуги
    • Отчетная документация по НИР, ОКР, НИОКР
      • Что такое НИР, ОКР, НИОКР
      • Инициативная разработка продукции
      • Проведение испытаний и изготовление опытного образца
      • Этапы выполнения опытно-конструкторской работы
    • Оформление паспорта оборудования
    • Разработка документации на автоматизированные системы
      • Разработка документации на автоматизированные системы
      • Стадии создания автоматизированных систем
      • Опытная эксплуатация
    • Разработка конструкторской документации
      • ГОСТы ЕСКД скачать
      • Особенности разработки конструкторской документации:
      • Виды и комплектность конструкторской документации
      • ЕСКД история возникновения
      • Разработка чертежей
      • Оформление КД для иностранных заказчиков
    • Разработка обоснования безопасности
      • Роль разработки обоснования безопасности на опасных производственных объектах
      • Что включают в себя требования к надежности производственного оборудования при разработке обоснования безопасности
    • Разработка программной документации
      • Разработка руководства оператора
      • Разработка руководства системного программиста
      • Стадии и этапы разработки программной документации
      • Виды программных документов
      • ГОСТы ЕСПД скачать
      • Документация для ПО по ГОСТ
      • Программная документация и ее разновидности
    • Разработка руководства по эксплуатации
      • Признаки грамотно составленного руководства по эксплуатации оборудования
      • Интерактивные руководства. Что такое ИЭТР, классы ИЭТР.
      • Разработка видеоруководств
    • Разработка технических заданий
      • Как формируются требования при составлении технического задания
      • Основные ошибки при разработке технического задания и как их избежать
      • Пишем статью
      • Разработка технического задания на ПО
      • Что такое техническое задание и как его разрабатывать
    • Разработка технических условий
    • Разработка технологической инструкции
      • Виды технологической документации
      • Стадии разработки технологической документации
      • Единая система технологической документации
    • Документация для сертификации оборудования
      • Для чего проводится сертификация продукции, какие необходимы документы
    Примеры работ
    • Конструкторская документация
    • 3D моделирование, визуализация
    • Документация для сертификации оборудования
    • Документация на автоматизированные системы
    • Программная документация
    • Технические задания
    Информация
    Контакты
      8 (812) 920-85-37
      E-mail
      zakaz@tehpis.ru
      Адрес
      194100, г. Санкт-Петербург, Лесной проспект 64 литера А пом 1-Н
      Tehpis.ru: Разработка технической документации, статей и публикаций
      Телефоны
      8 (812) 920-85-37
      E-mail
      zakaz@tehpis.ru
      Адрес
      194100, г. Санкт-Петербург, Лесной проспект 64 литера А пом 1-Н
      Tehpis.ru: Разработка технической документации, статей и публикаций
      • Главная
      • О компании
        • О компании
        • О компании
        • Новости
        • Контакты
      • Услуги
        • Услуги
        • Отчетная документация по НИР, ОКР, НИОКР
          • Отчетная документация по НИР, ОКР, НИОКР
          • Что такое НИР, ОКР, НИОКР
          • Инициативная разработка продукции
          • Проведение испытаний и изготовление опытного образца
          • Этапы выполнения опытно-конструкторской работы
        • Оформление паспорта оборудования
        • Разработка документации на автоматизированные системы
          • Разработка документации на автоматизированные системы
          • Разработка документации на автоматизированные системы
          • Стадии создания автоматизированных систем
          • Опытная эксплуатация
        • Разработка конструкторской документации
          • Разработка конструкторской документации
          • ГОСТы ЕСКД скачать
          • Особенности разработки конструкторской документации:
          • Виды и комплектность конструкторской документации
          • ЕСКД история возникновения
          • Разработка чертежей
          • Оформление КД для иностранных заказчиков
        • Разработка обоснования безопасности
          • Разработка обоснования безопасности
          • Роль разработки обоснования безопасности на опасных производственных объектах
          • Что включают в себя требования к надежности производственного оборудования при разработке обоснования безопасности
        • Разработка программной документации
          • Разработка программной документации
          • Разработка руководства оператора
          • Разработка руководства системного программиста
          • Стадии и этапы разработки программной документации
          • Виды программных документов
          • ГОСТы ЕСПД скачать
          • Документация для ПО по ГОСТ
          • Программная документация и ее разновидности
        • Разработка руководства по эксплуатации
          • Разработка руководства по эксплуатации
          • Признаки грамотно составленного руководства по эксплуатации оборудования
          • Интерактивные руководства. Что такое ИЭТР, классы ИЭТР.
          • Разработка видеоруководств
        • Разработка технических заданий
          • Разработка технических заданий
          • Как формируются требования при составлении технического задания
          • Основные ошибки при разработке технического задания и как их избежать
          • Пишем статью
          • Разработка технического задания на ПО
          • Что такое техническое задание и как его разрабатывать
        • Разработка технических условий
        • Разработка технологической инструкции
          • Разработка технологической инструкции
          • Виды технологической документации
          • Стадии разработки технологической документации
          • Единая система технологической документации
        • Документация для сертификации оборудования
          • Документация для сертификации оборудования
          • Для чего проводится сертификация продукции, какие необходимы документы
      • Примеры работ
        • Примеры работ
        • Конструкторская документация
        • 3D моделирование, визуализация
        • Документация для сертификации оборудования
        • Документация на автоматизированные системы
        • Программная документация
        • Технические задания
      • Информация
      • Контакты
      • 8 (812) 920-85-37
        • Телефоны
        • 8 (812) 920-85-37
      • 194100, г. Санкт-Петербург, Лесной проспект 64 литера А пом 1-Н
      • zakaz@tehpis.ru

      Wiki-системы и их особенности применения для программной документации

      Технический писатель - разработка документации по ГОСТ 34, ГОСТ 2, ГОСТ 19
      —
      Информация
      —
      Статьи
      —Wiki-системы и их особенности применения для программной документации

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

      Как создать архив программных документов на проект? Как упорядочить разработанные документы? Как проконтролировать разработку программной документации одновременно несколькими специалистами? Помощником в данных вопросах выступит Wiki-система – инструмент, позволяющий сообща создавать и редактировать документацию. 

      Wiki-системы можно разделить на публичные, корпоративные и частные. Доступ к просмотру и редактированию информации, размещенной в публичных системах, имеет любой пользователь сети. Частные системы позволяют создавать персональные базы знаний. Доступ к таким системам ограничен одним пользователем. В рамках данной статьи особый интерес представляют корпоративные системы. Именно в таких системах осуществляется обмен документами. 
      У Wiki-систем широкий спектр возможностей. К ним можно отнести:
      • набор шаблонов для страниц и разделов;
      • редактирование страниц;
      • учет изменений;
      • контроль доступа;
      • инструменты для систематизации (разделы, тэги, папки);
      • поисковые инструменты;
      • комментарии.
      Выделим наиболее известные Wiki-системы:
      • Confluence,
      • Coda,
      • Evernote,
      • Notion,
      • DropBox Paper.
      Первая система под названием Confluence доступна для операционных систем Windows и Linux. Интерфейс Confluence удобный и интуитивно понятный. В системе есть возможность скачивать страницу в формате .doc и .doc-x. В Confluence пользователи могут получать оповещения о внесенных изменениях в документы. Основным недостатком Confluence является недоступность ее в настоящее время для покупки и отсутствие поддержки на территории Российской Федерации в связи с событиями на мировой арене. 

      13_29.jpg

      Coda – одна из систем, позволяющих редактировать программные документы. Coda доступна на Android и IOS, также существует веб-версия приложения. Coda не требует дополнительных вложений и абсолютно бесплатна для пользователей. Отличает данную систему широкий ассортимент шаблонов. Для освоения платформы разработчики предоставили видеоинструкции с демонстрацией всех возможностей Coda. Приложение имеет ряд недостатков: отсутствие десктопного приложения; медленная работа на Android; приложение не имеет русскоязычной версии.

      13_30.jpg

      Популярной среди project-менеджеров стала программа Evernote, доступная для Windows, Mac, Android и IOS. Evernote отличает интуитивный интерфейс, что упрощает освоение новыми пользователями. К преимуществам также можно отнести возможность прикрепления голосовых сообщений и синхронизацию нескольких устройств (компьютера и смартфона). У Evernote есть ряд недостатков. Бесплатный тариф представлен всего на 60 Мб, что не подходит для свободного размещения полного пакета программных документов компании. Кроме того, поиск по заметкам в Evernote крайне неудобен.

      13_31.jpg

      Рассмотрим следующую систему Notion. Разработчики позиционируют ее как «рабочее пространство для всего». Приложения Notion доступны для Windows, Mac, Android, IOS, а также существует веб-версия. Основное преимущество программы – это возможность одним кликом изменить вид информационной таблицы и превратить ее в канбан-доску, календарь или галерею карточек. В Notion в отличие от Evernote есть возможность упорядочить карточки по собственному желанию, а не по дате или другим критериям. У программы есть ряд недостатков: Notion требует постоянного подключения к Интернету; в бесплатной версии имеется ограничение по количеству единиц контента (1000 блоков); для освоения всех возможностей и инструментов системы не хватает подсказок или видеоинструкций.  

      13_32.jpg

      Приложение DropBox Paper доступно для Windows, Mac, Linux, Android и IOS, а также существует веб-версия. Приложение бесплатное, что является основным его преимуществом. Кроме того, дизайн DropBox Paper минималистичен. Стоит отметить удобство импорта в DropBox файлов любых форматов. К недостаткам DropBox можно отнести ограниченные возможности редактирования и экспорта.

      13_33.jpg

      Wiki-системы являются главным помощником при подготовке программной документации. Список Wiki пополняется с каждым годом, что усложняет процесс выбора. Понять, какое приложение подойдет именно вам, можно только на практике.

      Wiki-системы сокращают время разработки программной документации. Подобных систем на данный момент довольно много. Наша команда помогает быстро и качественно создавать программную документацию в наиболее популярных Wiki-системах.

      Назад к списку
      • Статьи
      • Вопрос-ответ
      • Отзывы
      Разработка ТИ
      Документация для сертификации
      Разработка РЭ
      Разработка ОБ
      Оформление ПС
      Разработка ТУ
      Отчетная документация по НИР, ОКР, НИОКР
      Разработка ТЗ
      Документация на ПО
      Разработка КД
      Документация на АС
      О нас
      Вопрос-ответ
      Новости
      Статьи
      8 (812) 920-85-37
      8 (812) 920-85-37
      E-mail
      zakaz@tehpis.ru
      Адрес
      194100, г. Санкт-Петербург, Лесной проспект 64 литера А пом 1-Н
      zakaz@tehpis.ru
      194100, г. Санкт-Петербург, Лесной проспект 64 литера А пом 1-Н
      © 2012-2026
      Политика конфиденциальности