Оставить заявку

Виктор Фигурнов (Все сообщения пользователя)

Форум » Пользователи » Виктор Фигурнов

Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru! 
@twriters
 obmen_soobsheniyami.pngчат для технических писателей в Telegram

 Зарегистрируйтесь
Выбрать дату в календареВыбрать дату в календаре

Страницы: Пред. 1 2 3 4 5 6 7 8 9 10 11 12 След.
Выбор системы разработки программной и технической документации, Есть требования к системе, нужна помощь с подбором ПО.
 
[QUOTE]H&M'альщик написал:
Да я их смотрел, читал обзоры, сравнивал и т.д. Но дело в том, что оформление по ЕСКД (штампы, рамки) для нас получается в приоритете: в этих системах из коробки оформление по ЕСКД нет (я не нашел). [/QUOTE]
Этого вы нигде не найдете. Все серьезные системы подготовки документации делаются в расчете на на мировой рынок, их разработчиков интересуют потребности массовых платежеспособных пользователей, прежде всего, пользователей США, Европы, Канады, Японии, Австралии, Китая, стран Юго-восточной Азии. Фирмы-разработчики вряд ли будут отвлекать свои ресурсы для обеспечения странных игр нескольких живущих в захолустье нанайских мальчиков в рамочки и штампики.

И потом, ЕСКД меняется - так, за 2012-2014 г. вступило в силу 25 новых и измененных стандартов ЕСКД. Кроме того, в России вводятся и меняются стандарты документации для других отраслей - для строительства, градостроительства, фармацевтики, для организационно-распорядительной документации. Все эти стандарты разные. Вы надеетесь, что найдется фирма-разработчик, которая будет отслеживать изменения в сотнях российских стандартов, а также в десятках тысяч аналогичных стандартов других стран, чтобы обеспечивать десятки тысяч разных шаблонов документации?

Мне кажется, что задача должна ставиться иначе - надо выяснить, можно ли в системе подготовки документации обеспечить нужно оформление, печатных и электронных документов насколько просто и удобно это делается, какие имеются ограничения, и исходя из этого принимать решение. По моему мнению, нужные рамки и штампики, требуемые форматы нумерации элементов документов, разбиения многостраничных таблиц и т.д. можно обеспечить во всех четырех существующих на рынке профессиональных системах подготовки технической документации — в Madcap Flare, Adobe Robohelp, Adobe Framemaker и Author-It.
Выбор системы разработки программной и технической документации, Есть требования к системе, нужна помощь с подбором ПО.
 
[QUOTE]Текрайтер из Питера написал:
-- Если надо - с такими возможностями параметризации и управления, которые Docbook и DITA не снились.
Например? Мне было бы интересно услышать... Т.к. я сам не сталкивался.[/QUOTE]
Да любыми. LaTeX это полный по Тьюрингу язык программирования. Практически всё, что вы можете себе представить изображенным на бумаге, может быть выведено средствами LaTeX. Любые тексты, любые рисунки, любое оформление. Например, можно задать значения текстов надписей на круглой печати, и название файла рисунка, и топик LaTeX выведет изображение круглой печати с заданными надписями по кругу и заданным рисунком в центре. С помощью LaTeX можно по заданным данным вывести графики и диаграммы, в том числе 3-мерные графики, по ходам шахматной партии можно сгенерировать текст описания шахматной партии с картинками расположения шахматных фигур на доске в заданные моменты партии, и т. д., и т. п.
Выбор системы разработки программной и технической документации, Есть требования к системе, нужна помощь с подбором ПО.
 
[QUOTE]Текрайтер из Питера написал:
В связи с тем, что у вас Latex, то это значит НЕ topic-oriented изложение. [/QUOTE]
Ничто не мешает в LaTeX разделять текст на топики и включать их командами \input и \include.
Если надо - с такими возможностями параметризации и управления, которые Docbook и DITA не снились.
Выбор системы разработки программной и технической документации, Есть требования к системе, нужна помощь с подбором ПО.
 
На базе LaTeX систему, работающую по принципу единого источника, собрать вряд ли возможно. По принципиальным соображениям.

LaTeX это полный по Тьюрингу язык программирования, ориентированный на создание печатного представления научной информации (книг, статей и т.п.).

Он заточен на то, чтобы точно специфицировать и создавать печатное представление информации на листах бумаги заданного формата.

Тогда как принцип единого источника предполагает, что формат представления информации на разных носителях должен быть разный,

Например, на бумаге - одно представление, на мониторе большого формата - другое, на экране смартфона - третье.

И формат представления может динамически меняться - например, при изменении размера окна с текстом. Или при изменении ориентации смартфона/планшета.

Кроме того, в современной онлайн-документации часто применяются интерактивные элементы, типа Pop-up, togglers и др., которые в LaTeX не предусмотрены.

Можно сделать конверторы из подмножеств LaTeX в HTML, HTML5, CHM, формат Wiki, или Markdown. Кое-какие конверторы уже созданы энтузиастами.
Но это годится лишь для любительских нужд. Т.к. заметно увеличивает сложность и трудоемкость поддержки системы документации.
Профессиональные системы подготовки документации (Madcap Flare, Robohelp, Author-it и пр.) такие поделки не используют .
Изменено: Виктор Фигурнов - 01.02.2016 11:20:51
СПб. Разыскивается технический писатель!!!
 
Вы хотите трех специалистов в одном флаконе. Технический писатель, тестировщик и специалист по работе с заказчиками.
У них разные задачи, неизбежен конфликт интересов и приоритетов.
Не видно контента, Не видно контента в формате CHM
 
[QUOTE]bmwdp написал:
почему блокирует,[/QUOTE]
Для обеспечения безопасности. Формат chm имеет ряд существенных проблем с безопасностью.

Microsoft отказалась от формата chm еще в 2002 году.

Но для тех своих продуктов, которые использовали формат chm (Windows XP, Office 2000, XP и др.), Microsoft в 2003-2007 гг. выпустила около десятка патчей и обновлений, закрывающих проблемы, связанные с chm.

Новые операционные системы и продукты Microsoft формат chm не используют.

[QUOTE]bmwdp написал:
смысла тогда в этом формате и Win7\8\10.
[/QUOTE]

Формат CHM в новых операционных системах можно использовать на тех же правах, что программы для DOS или Windows 3.

Т.е., в большинстве случаев их можно заставить работать, если предпринять некоторые танцы с бубном.
Чем отличается документация от спецификации, отличие спецификации и джокументации
 
[QUOTE]''ivs0'' написал:
Согласно ГОСТ 2.106-96
Спецификация, это конструкторский  документ[/QUOTE]
Этим ГОСТом следует руководствоваться, только если подготавливается конструкторская документация на изделия машиностроения или приборостроения, и разработчик или заказчик восхотел исполнять ГОСТ 2 ЕСКД.

В других областях применения под спецификацией понимаются иные документы.

Например, для проектной документации для строительства имеется ГОСТ 21.110-2013 "Спецификация оборудования, изделий и материалов".

Для программной документации имеется ГОСТ 19.202-78 "Спецификация.Требования к содержанию и оформлению".

Могут быть и ведомственные/корпоративные стандарты или традиции о составлении и содержании спецификаций.
Файл PDF: Как показывать область закладок по умолчанию
 
Описанные возможности доступны и в Adobe Acrobat Standard, и Adobe Acrobat Professonal.
Бесплатных редакторов PDF файлов, имеющих эти возможности, я не знаю.
Из Excel в Word, Решение задачи
 
[QUOTE]Texasky написал:
Есть приглашение на экскурсию написанное в Word. Где сам текст приглашения не меняется, а имя, дата, и место экскурсии выводятся автоматически из базы данных  Excel. [/QUOTE]
Использовать функции слияния Word ([URL=https://support.office.com/ru-ru/article/%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D0%BD%D0%B5%D0%BD%D0%B8%D0%B5-%D1%81%D0%BB%D0%B8%D1%8F%D0%BD%D0%B8%D1%8F-%D0%B4%D0%BB%D1%8F-%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D0%BD%D0%B8%D1%8F-%D0%B8-%D0%BF%D0%B5%D1%87%D0%B0%D1%82%D0%B8-%D0%BF%D0%B8%D1%81%D0%B5%D0%BC-%D0%B8-%D0%B4%D1%80%D1%83%D0%B3%D0%B8%D1%85-%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%BE%D0%B2-428328de-3d94-4997-a73e-3b992922ccf5]ссылка[/URL]) ([URL=https://www.youtube.com/watch?v=tBEf0RsMmZc]ссылка[/URL])
Файл PDF: Как показывать область закладок по умолчанию
 
[QUOTE]Alex_Gur написал:
чтобы при открытии файла PDF в Adobe Reader по умолчанию показывалась область интерактивного оглавления (закладок)[/QUOTE]
Открываете PDF файл в Adobe Acrobat.
Выводите свойства файла (Ctrl+D).
Переходите на вкладку "Вид при открытии".
Значение параметра "Вкладка навигации" устанавливаете в "Панель закладок и страница".
Жмете OK.
Сохраняете файл.
Отчет, отчет по анализу материалов технической поддержки
 
[QUOTE]Десятник написал:
по анализу материалов технической поддержки и полного сопровождения (а именно, анализ технических заданий, отчетной документации[/QUOTE]
Сначала вам необходимо получить а[COLOR=#373737]нализ материалов технической поддержки,[/COLOR][COLOR=#373737] технических заданий, отчетной документации.
[/COLOR]Если вы технический писатель, то в ваши обязанности выполнение таких анализов не входит. Анализом должны заниматься аналитики.
Вот когда получите результаты их анализа, и будете думать, в какой отчет или какие отчеты их надо свести.[COLOR=#373737]
[/COLOR]
Чем отличается документация от спецификации, отличие спецификации и джокументации
 
Спецификация - это один из видов документации. Стандартом ISO/IEC/IEEE 15289:2015 "Содержание информационных продуктов процесса жизненного цикла систем и программного обеспечения (документация)" предусмотрены семь основных видов документации: Спецификация, Описание, Отчет, План, Политика, Процедура, Запрос

Вот что там говорится про спецификации[QUOTE][B]7.8 Specification[/B]
Purpose: provide requirements for a required service, product, or process. Specifications should use a well-defined syntax. Specifications should be internally consistent in terminology, definitions, and constraints. Unique specifications should be defined once to prevent inconsistent updates. A specification shall include the following elements:
a) Date of issue and status
b) Scope
c) Issuing organization
d) References
e) Approval authority
f) Body
g) Assurance requirements
h) Conditions, constraints, and characteristics
i) Glossary
j) Change history[/QUOTE]
Получение децимального номера, Как получить децимальный номер, какие документы для этого нужны и все вопросы о получении децимального номера.
 
[QUOTE]Kenning написал:
назначать данный номер согласно порядковому номеру разработанного ПО не вижу смысла[/QUOTE]
Если вам или вашему начальству захотелось соблюдать ГОСТы 40-летней давности, принятые в давно несуществующем государстве - о каком "смысле" вы можете говорить?
Тупо соблюдайте то, что там написано, и будет вам счастье.

[QUOTE]Kenning написал:
Если нет нормативного документа, регламентирующего порядок присвоения регистрационного номера ПО[/QUOTE]
Я привел цитату из ГОСТ [COLOR=#696969]19.103-77, [/COLOR][COLOR=#373737]регламентирующую порядок присвоения регистрационного номера. Вы уж определитесь, будете ли соблюдать ГОСТЫ или руководствоваться собственным усмотрением.
[/COLOR]
[QUOTE]Kenning написал:
согласно коду ОКП, раздел 5 (программные продукты). [/QUOTE]
ОКП выводится из употребления и с 1 января 2017 года отменяется. Вместо ОКП надлежит использовать Общероссийский классификатор продукции по видам экономической деятельности ОК 034-2014, введенный в действие с 1 февраля 2014 г.
Изменено: Виктор Фигурнов - 23.12.2015 16:53:34
Получение децимального номера, Как получить децимальный номер, какие документы для этого нужны и все вопросы о получении децимального номера.
 
[QUOTE]Kenning написал:
Цитирую: "Регистрационный номер присваивают в соответствии с Общесоюзным классификатором программ, утверждаемым Госстандартом в установленном порядке
[/QUOTE]
Вы совсем не видите разницы между Общесоюзным классификатором [B]программ[/B] и [COLOR=#696969]Общесоюзным классификатором [B]документов[/B]???
[/COLOR]
Насчет [COLOR=#373737]Общесоюзного классификатора программ - этот классификатор никогда не был разработан. За что Госстандарту СССР слава и хвала.
[/COLOR]
Можете руководствоваться следующей мантрой из ГОСТ [COLOR=#696969]19.103-77:
[/COLOR][QUOTE]До утверждения Общесоюзного классификатора программ допускается присваивать регистрационный номер в порядке возрастания, начиная с 00001 до 99999, для каждой организации (предприятия)-разработчика.[/QUOTE]
Получение децимального номера, Как получить децимальный номер, какие документы для этого нужны и все вопросы о получении децимального номера.
 
[QUOTE]Kenning написал:
ГОСТ 19.103-77 ссылается на Общесоюзный классификатор документов, который сейчас заменён Общероссийским классификатором документов.

[/QUOTE]
[COLOR=#373737]Вы ничего не путаете? В ГОСТ 19.103-77 нет ссылки на Общесоюзный классификатор документов, о существовании такого классификатора мне неизвестно, и гугль с яндексом тоже молчат.
[/COLOR][COLOR=#373737]Общероссийского [/COLOR][COLOR=#373737]классификатора документов[/COLOR] также никогда не существовало. Есть ОКУД (Общероссийский классификатор управленческой документации).
Изменено: Виктор Фигурнов - 23.12.2015 13:41:53
Техническое описание, Нужна помощь
 
Для программ документ "Техническое описание" не предусмотрен ни ГОСТами, ни международными стандартами ISO,
Что может содержаться в таком документе - непонятно.
Попробуйте заменить его на "Описание программы" (ГОСТ 19.402-78)
Средний темп работы технического писателя, Какой план (лист/час) должен делать технический писатель)
 
[B][COLOR=#333333]ГОСТ Р ИСО/МЭК 15910-2002
[/COLOR][/B]
[B][COLOR=#333333]ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА
[/COLOR][/B]
[B][COLOR=#333333]ПРИЛОЖЕНИЕ F[/COLOR][/B][B][COLOR=#333333] [/COLOR][/B][B][COLOR=#333333](справочное)
[/COLOR][/B]
[B][COLOR=#333333]F[/COLOR][/B][B][COLOR=#333333].2 ПОМИНУТНЫЙ И ПОЧАСОВОЙ МЕТОДЫ
[/COLOR][/B]
[COLOR=#333333]Данные методы предусматривают около 3 ч для написания страницы текста, пригодного для публикации. Время, необходимое для создания графических материалов, определяется их сложностью и количеством черновиков, необходимых для создания соответствующего оригинала
[/COLOR][COLOR=#333333].[/COLOR]
[COLOR=#333333]По общей оценке требуется от 3 до 5 ч для создания и корректировки типового графического материала, используемого в программной документации (исключая экранные распечатки).
[/COLOR]
[COLOR=#333333]В начале проекта трудно оценить общий постраничный объем создаваемой документации. Если для завершения проекта требуется более 2 мес, подсчет страниц должен быть проведен по истечении первого месяца.
[/COLOR]
[COLOR=#333333]Для очень больших проектов номенклатура поставки должна быть разделена на части, поддающиеся управлению. При этом оценка сроков завершения проекта в целом может быть дана только в количестве месяцев, а детально может быть оценена лишь первая часть работы. При использовании данного метода документатор и заказчик должны сверить свои оценки сроков завершения проекта.
[/COLOR]
[COLOR=#333333]В таблице [/COLOR][URL=http://ohranatruda.ru/ot_biblio/normativ/data_normativ/39/39662/#i2108906][COLOR=purple]F.1[/COLOR][/URL][COLOR=#333333] приведены сроки реализации «типового» (гипотетического) проекта. При этом предполагается, что автор готовит материалы непосредственно на персональном компьютере, и для их выпуска используют портативные издательские системы.
[/COLOR]
[COLOR=#333333][B]Таблица F.1[/B][/COLOR][COLOR=#333333][B] - Ориентировочные сроки[/B][/COLOR] [TABLE][TR][TD]Этап
[/TD][TD]Срок
[/TD][/TR][TR][TD]Определение номенклатуры поставки[/TD][TD]16 ч на проект[/TD][/TR][TR][TD]Исследование содержания документации[/TD][TD]24 ч на проект[/TD][/TR][TR][TD]Написание плана документирования[/TD][TD]48 ч на проект[/TD][/TR][TR][TD]Проектирование структуры документа и правил оформления его страниц[/TD][TD]8 ч на том[/TD][/TR][TR][TD]Написание первой редакции (документации)[/TD][TD]1 ч на страницу[/TD][/TR][TR][TD]Разработка графических материалов[/TD][TD]5 ч на материал[/TD][/TR][TR][TD]Объединение текстовых и графических материалов[/TD][TD]30 мин на страницу[/TD][/TR][TR][TD]Проверка первой редакции (эксперт)[/TD][TD]30 мин на страницу[/TD][/TR][TR][TD]Корректировка первой редакции и графики[/TD][TD]30 мин на страницу[/TD][/TR][TR][TD]Внесение замечаний пользователя[/TD][TD]30 мин на страницу[/TD][/TR][TR][TD]Грамматическое редактирование[/TD][TD]15 мин на страницу[/TD][/TR][TR][TD]Подготовка второй редакции (документации)[/TD][TD]15 мин на страницу[/TD][/TR][TR][TD]Проверка второй редакции (эксперт)[/TD][TD]15 мин на страницу[/TD][/TR][TR][TD]Окончательная корректировка документации[/TD][TD]10 мин на страницу[/TD][/TR][TR][TD]Нормоконтроль документации[/TD][TD]15 мин на страницу[/TD][/TR][TR][TD]Изготовление фотошаблонов[/TD][TD]3 сут[/TD][/TR][TR][TD]Печать и переплетение оригиналов[/TD][TD]5 сут[/TD][/TR][TR][TD]Печать и брошюровка копий[/TD][TD]10 сут[/TD][/TR][TR][TD]Рассылка[/TD][TD]1 сут[/TD][/TR][/TABLE][B][COLOR=#333333]
[/COLOR][/B][B][COLOR=#333333]F[/COLOR][/B][B][COLOR=#333333].3 МЕТОД НИСХОДЯЩЕГО ПРОЕКТИРОВАНИЯ
[/COLOR][/B]
[B][COLOR=#333333]F.3.1 Общие положения
[/COLOR][/B]
[COLOR=#333333]Данный метод основан на предположении, что число страниц в публикации(ях) может быть оценено достаточно просто с использованием следующих допущений:[/COLOR]
[COLOR=#333333]a) автор может за месяц подготовить 22 страницы нового текста;[/COLOR]
[COLOR=#333333]b) автор может за месяц подготовить 44 страницы текста с изменениями.[/COLOR]
[COLOR=#333333]Например, объем публикации оценен в 150 страниц. Поскольку это новая публикация, получаем: 150/22 = 7чел./мес. В эти 7 мес. входят: планирование публикации, ее написание, редактирование и проверка двух редакций, а также подготовка фотошаблонов.
[/COLOR]
[B][COLOR=#333333]F.3.2 Пропорции[/COLOR][/B]
[COLOR=#333333]Продолжительность 7 чел./мес распределена в следующих пропорциональных отношениях:[/COLOR]
[COLOR=#333333]a) 15 % - планирование (в данном примере - четыре недели);[/COLOR]
[COLOR=#333333]b) 50 % - написание первой редакции (14 недель);[/COLOR]
[COLOR=#333333]c) 25 % - написание второй редакции (семь недель);[/COLOR]
[COLOR=#333333]d) 10 %- подготовка фотошаблонов (три недели).
[/COLOR]
[B][COLOR=#333333]F[/COLOR][/B][B][COLOR=#333333].3.3 Планирование[/COLOR][/B]
[COLOR=#333333]Период планирования охватывает:[/COLOR]
[COLOR=#333333]a) исследования и подготовку плана;[/COLOR]
[COLOR=#333333]b) изучение и проверку плана;[/COLOR]
[COLOR=#333333]c) корректировку плана по результатам проверки.
[/COLOR]
[B][COLOR=#333333]F[/COLOR][/B][B][COLOR=#333333].3.4 Первая редакция[/COLOR][/B]
[COLOR=#333333]Период первой редакции охватывает:[/COLOR]
[COLOR=#333333]a) подготовку содержания (плана-проспекта) документации;[/COLOR]
[COLOR=#333333]b) изучение и проверку содержания (плана-проспекта);[/COLOR]
[COLOR=#333333]c) подготовку пробного куска текста для редактора;[/COLOR]
[COLOR=#333333]d) редактирование пробного куска текста и его переписывание по замечаниям редактора;[/COLOR]
[COLOR=#333333]e) написание всей первой редакции документации;[/COLOR]
[COLOR=#333333]f) редактирование всей первой редакции документации;[/COLOR]
[COLOR=#333333]g) переработку отредактированной документации;[/COLOR]
[COLOR=#333333]h) изучение и проверку переработанной документации.[/COLOR]
[COLOR=#333333]Иллюстративные материалы готовят одновременно с текстом первой редакции.
[/COLOR]
[B][COLOR=#333333]F[/COLOR][/B][B][COLOR=#333333].3.5 Вторая редакция[/COLOR][/B]
[COLOR=#333333]Период второй редакции охватывает:[/COLOR]
[COLOR=#333333]a) внесение в документацию всех изменений, предложенных по результатам проверки первой редакции;[/COLOR]
[COLOR=#333333]b) повторное (второе)редактирование второй редакции документации;[/COLOR]
[COLOR=#333333]c) переработку отредактированной[/COLOR][COLOR=#333333] [/COLOR][COLOR=#333333]документации;[/COLOR]
[COLOR=#333333]d) изучение и проверку переработанной документации.
[/COLOR]
[B][COLOR=#333333]F[/COLOR][/B][B][COLOR=#333333].3.6 Принятая редакция[/COLOR][/B]
[COLOR=#333333]Редакцией для фотонабора является принятая редакция документирования. Ее подготовка охватывает:[/COLOR]
[COLOR=#333333]a) [/COLOR][COLOR=#333333]внесение в документацию всех изменений, предложенных по результатам проверки второй редакции;[/COLOR]
[COLOR=#333333]b) [/COLOR][COLOR=#333333]проверку правильности внесения данных изменений;[/COLOR]
[COLOR=#333333]c) [/COLOR][COLOR=#333333]удаление всех[/COLOR][COLOR=#333333] [/COLOR][COLOR=#333333]редакционных разметок;[/COLOR]
[COLOR=#333333]d) [/COLOR][COLOR=#333333]изготовление фотошаблонов;[/COLOR][COLOR=#333333] [/COLOR]
[COLOR=#333333]e) [/COLOR][COLOR=#333333]отправку фотошаблонов в печать (в типографию)
[/COLOR][COLOR=#333333]. [/COLOR]
[COLOR=#333333]Обычно экспертам (нормоконтролерам) требуется от одной до двух недель для изучения и подготовки замечаний, а сама проверка занимает от одного до нескольких дней.
[/COLOR]
[COLOR=#333333]Метод нисходящего проектирования может быть использован для существующих публикаций. Например, книга объемом 100 страниц может быть переработана так, что половина ее изменяется и добавляется 10 % новых материалов. Используя вышепринятые допущения, получаем: 50/44 = 1,13 чел./мес для существующего материала плюс 10/22 = 0,45 чел./мес для внесения нового материала.
[/COLOR]
[COLOR=#333333]Когда сроки, необходимые для создания документации, превышают допустимые, для выполнения задания следует привлекать несколько авторов. Так же следует поступать при подготовке нескольких документов для одного программного средства.[/COLOR]
Оформление разделов, пунктов, подпунктов по ГОСТ 19, оформление документации по ГОСТ 19
 
[QUOTE]H&M User написал:
Т.е. именно тире, а не точка (после номера рисунка).[/QUOTE]
Как обычно, здесь совковые гостописцы выкаблучились.

Такой стиль оформления не соответствует традициям как русской типографики, так и английской.
И там, и там в подписях к иллюстрациям номер и пояснительный текст принято разделять точкой и пробелом.
Это можно наблюдать как в книгах и журналах, так и в руководствах по стилю

[B]Мильчин, Ченцова. Справочник издателя и автора:[/B]
Рис 7.3. Простой приклейный форзац
Рис. 18. Типы составных переплетных крышек

[B]Chicago Manual of Stylе:[/B]
Figure 2. Schematic block diagram
Fig 4. DNA sequence
Fig. 9.4. Photosynthetic light response
Внутренний стандарт компании, Внутренний стандарт компании
 
[QUOTE]Ovin написал:
Надо разработать внутренний стандарт компании, на основании которого будет разрабатываться документация на создание и развитие ППО. [/QUOTE]
Целесообразно разделить задачу на две.
Один внутренний стандарт — на документацию. Какая она должна быть. Может быть несколько стандартов для разных типов документации.
Другой внутренний стандарт — на процесс документирования. Как инициируется процесс разработки документации, как он управляется, как и кем она разрабатывается, проверяется, утверждается, используется, публикуется, обновляется, отменяется.
Новый госконтракт, Подготовка к новому госконтракту
 
Если Вы имеете в виду внешнюю документацию (документацию, предоставляемую пользователям/заказчикам программного обеспечения), то стандарты ISO/IEC/IEEE на разработку такой документации рекомендуют определить требования к документации, составить и согласовать спецификацию на подготавливаемую документацию и техническое задание на подготовку документации. Затем, на их основе, составляются план документирования и план управления документированием  Процессы определения требований к документации, составления спецификации и технического задания на подготовку документации подробно освещены в стандарте ISO/IEC/IEEE 26512:2011 Systems and software engineering — Requirements for acquirers and suppliers of user documentation, а процессы составления плана документирования и плана управления документированием — в стандарте ISO/IEC/IEEE 26511:2011 Systems and software engineering. Requirements for managers of user documentation. Разумеется, при составлении этих планов, ТЗ, спецификации, должны учитываться целевая аудитория, требования к стоимости и времени работ, имеющиеся ресурсы, квалификация исполнителей и т.д., о чем также написано в указанных стандартах.
Где искать специалистов по написанию технической документации для перерабатывающей промышленности
 
Цитата
writer написал:
Технический писатель может писать и для пищевой промышленности
Без надлежащего бэкграунда, знания терминологии и базовых сведений в изготовленной техписом писанине неизбежно будут ошибки и ляпсусы.
Примерно такие как на картинке:

Формуляр на АПК с покупным ПО и оборудованием
 
Эти вопросы относятся не к компетенции технического писателя, а к компетенции руководителей и юристов.
Формуляр можно делать на что угодно. Гарантию можно обещать на что угодно.
Если вам прикажут написать, что ваша компания создала всю Вселенную и ее окрестности, вы можете это написать, или можете уволиться.
За написанный вами документ отвечать перед заказчиками, клиентами, государственными органами, будете не вы, а руководство организации.
Поля в Word
 
Удобно ссылки на рисунки оформлять так: на рис. 3, см. рис. 5, и т. д.
Но если требуется непременно ссылаться на рисунок в произвольной форме, то в Word и для этого есть способ, но он менее удобен и менее надежен.
Способ такой.
Создаете стиль для рисунков, например, [B]Picture[/B]. Задаете его оформление - шрифт, отступы и пр.
Находясь в абзаце стиля [B]Picture[/B] создаете новый формат номеров - [B]Главная[/B], треугольник в кнопке с нумерованным списком, [B]Определить новый формат номера[/B]
Выбираете параметры
-- [B]Нумерация [/B]1, 2, 3,
-- [B]Формат номера[/B] Рис. 1.
-- [B]Выравнивание [/B]По левому краю
Жмете OK.
Щелкаете тот же абзац правой кнопкой мыши. Выбираете в контекстном меню команду [B]Изменение отступов в списке[/B].
Вводите параметры отступов, например:
-- [B]Положение номера[/B] 0 см
-- [B]Отступ текста[/B] 1 см
[B]-- [/B][B]Символ после номера[/B] Пробел
И жмете OK.
Обновляете стиль
Теперь абзацы стиля [B]Picture[/B] будут автоматически нумероваться Рис 1, Рис. 2 и др.

Для вставки перекрестной ссылки
Устанавливаем текстовый курсор в место документа, куда надо вставить перекрестную ссылку на номер рисунка.
Выбираем команду [B]Вставка [/B]- [B]Перекрестная ссылка[/B], или [B]Ссылки [/B]- [B]Перекрестная ссылка[/B],
В выведенном окне [B]Перекрестные ссылки[/B]
-- в поле [B]Тип ссылки[/B] выбираем [B]Абзац[/B]
-- в поле [B]Вставить ссылку на[/B] выбираем [B]Номер абзаца[/B].
-- в поле [B]Для какого абзаца[/B] выделяем строку с подписью под рисунком
Жмем [B]Вставить[/B], а затем [B]Закрыть
[/B]
В документе появится поле перекрестной ссылки, например [B]Рис. 25
[/B]Если нужно чтобы ссылка выглядела так: [B]рис. 25[/B] (все буквы строчные), щелкаем вставленное в документ поле перекрестной ссылки правой кнопкой мыши, выбираем в контекстном меню [B]Изменить поле[/B], в поле [B]Формат[/B] выбираем [B]Все строчные[/B], и жмем [B]OK[/B].
Если нужно чтобы ссылка выглядела так: [B]25[/B] (только номер), щелкаем вставленное в документ поле перекрестной ссылки правой кнопкой мыши, выбираем в контекстном меню [B]Изменить поле[/B], устанавливаем флажок [B]Показывать только цифры и разделители[/B], и жмем [B]OK[/B].
Поля в Word
 
Вы видимо имеете в виду, "как делать в тексте перекрестные ссылки на номера рисунков".

Пусть у вас Word 2010
Выбираем раздел меню [B]Ссылки[/B], там жмем кнопку [B]Вставить название[/B]
В выведенном окне [B]Название[/B] жмем кнопку [B]Создать[/B], вводим идентификатор поля SEQ - в нашем примере [B]Picture[/B] и жмем [B]OK[/B]
В окне [B]Название[/B] жмем кнопку [B]Отмена[/B],

Теперь можно делать перекрестные ссылки на абзацы с SEQ-полями вида [B]Picture[/B]

Например, пусть подпись под рисунком - [B]Рис. 25. Красивая картинка[/B]
Здесь [B]Рис.[/B] и [B]Красивая картинка[/B] это введенный вами текст, а 25 - это значение SEQ-поля вида [B]Picture
[/B]
Устанавливаем текстовый курсор в место документа, куда надо вставить перекрестную ссылку на номер рисунка.
Выбираем команду [B]Вставка [/B]- [B]Перекрестная ссылка[/B], или [B]Ссылки [/B]- [B]Перекрестная ссылка[/B],
В выведенном окне [B]Перекрестные ссылки[/B]
-- в поле [B]Тип ссылки[/B] выбираем [B]Picture[/B] (этот тип ссылки появился из-за описанных выше действий по созданию названия)
-- в поле [B]Вставить ссылку на[/B] выбираем [B]Постоянная часть и номер[/B].
-- в поле [B]Для какого названия[/B] выделяем строку с подписью под рисунком (в нашем случае "Рис. 25. Красивая картинка")
Жмем [B]Вставить[/B], а затем [B]Закрыть
[/B]
В документе появится поле перекрестной ссылки [B]Рис. 25
[/B]
Если нужно непременно, чтобы ссылка выглядела так: [B]рис. 25[/B] (все буквы строчные), щелкаем вставленное в документ поле перекрестной ссылки правой кнопкой мыши, выбираем в контекстном меню [B]Изменить поле[/B], в поле [B]Формат[/B] выбираем [B]Все строчные[/B], и жмем [B]OK[/B].
Поля в Word
 
Нажмите [B]Ctrl-F9[/B]. В документе Word появятся две фигурные скобки[B] { }[/B]. Это пустое поле. Введите между фигурными скобками текст [B]SEQ Picture \* ARABIC[/B]

Находясь в поле, нажмите [B]F9[/B] - Обновить поле, и [B]Shift-F9[/B] - переключить режим показа поля коды/значение. Должно быть выведено число 1.

Но это не простое число 1. Это автоматически нумеруемое поле. Вы можете копировать это поле в другие места документа. Если вы выделите весь документ и нажмете [B]F9[/B], то эти поля будут пронумерованы, с помощью арабских цифр. Нумерация начнется с единицы.

Здесь [B]Picture[/B] это идентификатор данного автоматически нумеруемого перечня. Я его выбрал произвольно. В одном документе можно использовать поля [B]SEQ[/B] с разными идентификаторами. Например если в документе Word требуется автоматически нумеровать рисунки, таблицы и алгоритмы, можно использовать поля: [B]SEQ [B]Picture[/B] , [/B][B][B]SEQ Table , [/B][/B][B][B][B]SEQ Algorithm
[/B][/B][/B]
С помощью ключей поля [B]SEQ[/B] можно управлять нумерацией - например, задавать начальное значение.

Иногда удобно  задавать единицы автотекста, автоматически вставляющие в документ нужное поле.[B]
[/B]
Страницы: Пред. 1 2 3 4 5 6 7 8 9 10 11 12 След.

Рейтинг@Mail.ru