Знакомство с оформлением документации

Если да, то, какой?

Кстати, на проблему с шрифтами в FOP я тоже, в свое время потратил кучку времени, но оказалось, что делается это относительно просто. Несмотря на это выбор XEP — одобряю. Individym 17 февраля в 0. Кстати, вопрос, если еще этим занимаетесь — а каким плагином пользовались для сборки на TC, какой-то самописный или этот вот?

А то у нас сейчас постепенно встает вопрос оптимизации сборки используется самописная система на питоне , потому что 2 с лишним часа на полный документ это уже за гранью. Моя любовь не сочтите за рекламу : oXygen Author. Не дешевый. Но очень сильный. Долго использовали на начальном этапе Syntext Serna — но как-то потом не прижился. По немного смотрели на все перечисленные — но в итоге все таки остановились на обычном блокноте по крайней мере лично я. Не смотрели AsciiDoc? Он позволяет писать в удобном текстовом формате, который потом преобразовывается в DocBook.

Честно говоря нет. У нас документацию пишут программисты, поэтому все себя и так комфортно чувствуют при работе с XML. Если нужно сделать описания API библиотеки — то почему бы и не использовать. А если нужно вести руководство пользователя, ПМИ и т. Наверно как-то и можно это приладить это к inline документации в чем я сомневаюсь , но порядка точно больше не станет. Да, логично. ПМИ и пользовательские руководства всё же к проектной относятся. Докбук может стать проблемой, если в команде разработчиков есть ещё и технические писатели, которым в XML разбираться будет крайне некомфортно.

Недостаток — исходник практически нечитабелен, и в случае конфликта… Другой возможный вариант — fodt Open Document Format в чистом XML-е , его поддерживает LibreOffice — в особых случаях, когда нет возможности отказаться от вордоподобного интерфейса. Тут получается полноценный ворд-редактор и формат, относительно дружественный к VCS. Комментарий этот к тому, что недостаёт сравнения с аналогами.

И кстати, DocBook даже позволяет выгружать в него но на наших документах он почему-то спотыкается. Обратно, к сожалению, придется переносить изменения в ручную. Плюс, проверяющая сторона скорее всего будет ворчать на форматирование, так как fo полностью съедает логическое представление документа.

Составные части процесса управления внутренней документацией

А у нас небольшой велосипед на базе DocBook. NeoCode 17 февраля в 0. В частности Syntext Serna вроде как нацелена именно на DocBook. У нас похоже. А в чем диаграммы рисуете? Если честно, то рисовали в любом доступном редакторе и вставляли как картинку… Даже не знал, что есть такие штуки. Когда-то давно занимался документацией и мне казалось что DITA — это наоборот более простой по сравнению с DocBook подход. Syntext Serna была конечно довольно крутой штукой.

Irker 17 февраля в 0.

1. знакомства на один раз иркутск.
2. Recent Posts.
3. как познакомиться с парнем одной?
4. Электронный учебный курс: ДОУ!

Отступлю от темы: На примере документации php. Я вот не понимаю эту всеобщую любовь к XML-документированию. У нас в отдел выпуска программной документации купили Arbortext — на первый второй и третий взгляд говно. Во-первых, XML — не самый читабельный формат. Именно поэтому даже в обычной прогерской жизни многие стараются использовать JSON. Во-вторых, никто не знает всех этих тегов. И если программистам тут все достаточно понятно, то девочкам, которые всю жизнь щелкали по кнопкам ворда, будет крайне сложно объяснить весь дзен работы в текстовом редакторе с набором неизвестным им тегов.

Ага, устроить фаталити и поставить Vim. В-третьих, хоть и в некоторой мере решается проблема с мержами, но если вдруг есть конфликт — та еще боль мержить XML-файлы. В-четвертых, проблема с перегоном в паблишт форматы. Ну что за дела — пляски с бубном для получения PDF? Я не понимаю, почему никто никто ли? Во-первых, бывшие студенты технических вузов с очень высокой вероятностью знают LaTeX. В добавление к вышесказанному некоторые виды техдокументации нужны для удостоверения некоторых производственных работ в неукоснительном порядке. Эти виды работ прописаны в законодательных документах России.

Центр разработки Тарифы О компании Отзывы Контакты. Центр сертификации продукции база знаний разработка регистрация продукции. Решения для производителей и импортеров - рассматриваем и предлагаем решение любых поставленных задач. Регистрация продукции на всей территории РФ - Ваш регион, город и местоположение не имеют значения. Главная Статьи Разработка технической документации в Москве.

Эти документы имеют высший приоритет и общефедеральную значимость. Рассмотрим примеры таких документов. Оформление документов регламентируется стандартами для придания им юридической силы , а также для удобства работы с ними. Стандарт описывает типовой образец, которому должны соответствовать документы, системы и технологии. Область действия стандартов и их содержание определяются государственными органами управления. Основные стандарты в области делопроизводства :.

Национальный стандарт Российской Федерации. Система стандартов по информации, библиотечному и издательскому делу. Управление документами. Общие требования. Унифицированные системы документации. Унифицированная система организационно-распорядительной документации. Требования к оформлению документов. Информационная технология. Криптографическая защита информации. Процессы формирования и проверки электронной цифровой.