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

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

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

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

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

Страницы: 1 2 3 4 5 6 7 8 9 10 11 12 След.
Автогенерация документации из кода
 
Кажется, что SPHINX и AsciiDoctor (или AsciiDoc) это не системы автогенерации документации из кода.

А просто системы подготовки документации. Первая основана на языке упрощенной разметки RST, вторая на собственном языке, некоем "языком упрощенной разметки на стероидах".
Нумерация страниц в ТЗ, Нумерация страниц в ТЗ
 
А вы хоть раз читали ГОСТ 34.602-89 "Техническое задание на создание автоматизированной системы"?

3. ПРАВИЛА ОФОРМЛЕНИЯ

3.2. ...
Номера листов (страниц) проставляют, начиная с первого листа, следующего за титульным листом, [B]в верхней части листа (над текстом, посередине)[/B] после обозначения кода ТЗ на АС.
Тестовое задание на технического писателя
 
Я выполнял примерно такое задание, не один раз. Можете сравнить свой текст с моим: ссылка
Разработка технической документации, Разработка технической документации в соответсвии с ГОСТ
 
[QUOTE]102@svetorezerv.ruТребования к написанию текста проекта   ... Задача технического писателя или раскрыть или придумать сквозную цифровую технологию: (большие данные, нейротехнологии или искусственный интеллект) и написать текст[/QUOTE]
Похоже что вы ищете технического писателя для написания работы на соискание Нобелевской премии. :)
ГОСТ 19 какой шрифт для программного кода?, шрифт программного кода
 
В ГОСТ конкретный шрифт не указан. ГОСТ 19.106-78:
[QUOTE]Для выделения отдельных понятий допускается ... печатать отдельные слова или части текста шрифтом, отличным от печати основного текста[/QUOTE]
Можете использовать любой подходящий шрифт. Обычно для оформления консольных команд применяются моноширинные шрифты.
Изменено: Виктор Фигурнов - 03.12.2019 17:08:46
Жизненный цикл документации СМК, "Жизненный цикл документации" для Системы менеджмента качества?
 
ISO 9001:2015 Quality management systems - Requirements
ISO/IEC/IEEE 15289-2019 Systems and software engineering -- Content of life-cycle information items (documentation)
Примеры разработанной документации на MadCap Flare
 
[QUOTE]maxagg написал:
[URL=http://help.spds.ru]http://help.spds.ru[/URL] - документация на MadCap Flare[/QUOTE]
Это не так. В тексте всех справочников по этому адресу написано:

<met a name="generator" content="[B]Adobe Framemaker 2017[/B]" />
Требования к форматированию документации
 
"Расстояние между заголовками и текстом" я бы интерпретировал как расстояние от базовой линии заголовка до верхнего края прописных букв следующей строки текста.
Какой нужно установить для этого интервал после заголовка, зависит от:
[LIST][*]гарнитуры, кегля и интерлиньяжа заголовка
[*]гарнитуры, кегля и интерлиньяжа основного текста[/LIST]
Если гарнитура и кегль заголовка Times New Roman 14 pt, а интерлиньяж полуторный то после заголовка нужно делать отступ 27 pt. Это многовато, но ГОСТы не для красоты.
.
Пробел перед % и °C
 
По типографике там должен стоять тонкий 2-пунктовый пробел.
См. справочник Мильчина.
Оформление РП по ГОСТ
 
[QUOTE]Sofyaв более новой версии ГОСТ 2.601-2013 есть похожая фраза, но пример приведён странный:
"6.1 В тексте документа при изложении указаний о проведении работ применяют глаголы в повелительном наклонении, например: "Открыть люк...", "Нажать кнопку..." и т.п."
Т.е. сказано, что используется наклонение повелительное, но пример приведён для неопределенной формы глагола. И тогда нормоконтролёр может потребовать писать "требуется открыть люк...", "необходимо нажать кнопку...". [/QUOTE]
Нормоконтролер будет прав, и никаких оснований оспаривать его требования не имеется. Данным ГОСТом (точнее его вариантом еще от 1968 года) изменены правила госторусского языка, на котором следует гостописать гостодокументы. С тех пор в этом языке выражения "требуется открыть люк...", "необходимо нажать кнопку..." содержат глаголы в повелительном наклонении, а не в инфинитиве.
Оформление РП по ГОСТ
 
[QUOTE]Цахес написал:
Так он же входит в состав ЕСКД, а не ЕСПД?[/QUOTE]
1. РД 50-34.698-90 про который вы спрашивали тоже не входит в ЕСПД.
2. Вы сказали "в документации по ГОСТам не используется повелительное наклонение" а не "в документации по ЕСПД не используется повелительное наклонение"
Разберитесь сначала, чего вы хотите. РД 50-34.698-90 или ЕСПД или что-то еще.
В РД 50-34.698-90 сказано:
[QUOTE]Требования к содержанию документов, разрабатываемых. при создании АС, установлены настоящими указаниями, [B]а также[/B] соответствующими государственными стандартами Единой системы программной документации ([B]ЕСПД[/B]), Единой системы конструкторской документации ([B]ЕСКД[/B]), Системы проектной документации для строительства ([B]СПДС[/B]) и [B]ГОСТ 34.602[/B].[/QUOTE]
Изменено: Виктор Фигурнов - 07.09.2018 11:13:11
Оформление РП по ГОСТ
 
[QUOTE]Цахес написал:
мне говорили, что в документации по ГОСТам не используется повелительное наклонение, а используются слова "следует", "требуется", "необходимо". Не могу самостоятельно найти этому подтверждение, но помнится, что где-то это видела.[/QUOTE]
ГОСТ 2.601-95. Эксплуатационные документы
6.4 В тексте документа при изложении указаний о проведении работ [B]применяют глагол в повелительном наклонении[/B]
Технический проект, Показатели качества в сетях
 
[QUOTE]Десятник написал:
разногласия по поводу пункта "Сведения об обеспечении заданных в техническом задании (ТЗ)потребительских характеристик Системы (подсистем), определяющих ее качество"[/QUOTE]
Какие сейчас могут быть разногласия? Тупо смотрите что написано в техническом задании (ТЗ) о потребительских характеристиках Системы (подсистем), и пишете как эти характеристики обеспечиваются.

[QUOTE]Десятник написал:
эти отказываются понимать, что покрытие функций - это и есть качество продукта.[/QUOTE]
Они правы. ГОСТ Р ИСО/МЭК 25010-2015 "Требования и оценка качества систем и программного обеспечения (SQuaRE). Модели качества систем и программных продуктов" определяет качество систем иначе. Но философские дискуссии о качестве системы были уместны при составлении ТЗ. А сейчас вы должны описать как обеспечиваются характеристики указанные в ТЗ, и ни на йоту более.

Если "эти" хотят чего-то иного или большего, пусть заявляют о необходимости изменить ТЗ.
Документ "Проектное решение" что это такое и как его оформлять?, Документ "Проектное решение" , ГОСТ
 
[QUOTE]'''''writer''''' Zakharenko написал:
Привет, всем! Вопрос из нашего  [URL=http://t.me/twriters]телеграмма[/URL]
Что за документ "Проектное решение" и есть ли в ГОСТ его структура?[/QUOTE]
Проектное решение определено в ГОСТ 22487-77. Проектирование автоматизированное. Термины и определения как "Промежуточное или конечное описание объекта проектирования, необходимое и достаточное для рассмотрения и определения дальнейшего направления или окончания проектирования". Оно не обязано быть отдельным документом. Может быть частью документа или совокупностью документов и информационных ресурсов.

Определением понятия "Проектное решение" для других областей деятельности (Программная инженерия, Управление проектами, Проектирование бизнес-процессов и др.) гостописцы нас не осчастливили, за что им огромное спасибо.

Структуры "Проектного решения" в ГОСТах также нет. Но есть рекомендации Р 50-50-88 "САПР. Автоматизированная информационно-поисковая система агрегатирования приспособлений для станков с ЧПУ.  Типовое проектное решение", где есть структура, безнадежно устаревшая.
каким редактором это сделано?
 
Делается это примерно как описал revo, с цветами, прозрачностями, тенями, толщиной контуров там можно играться как заблагорассудится.

каким редактором это сделано?
 
Если такое можно сделать в Snagit прошу сообщить как.

У меня Snagit 2018, там такой возможности обнаружить не удалось.

В Photoshop такой эффект сделать очень просто.
Требование технологичности
 
[QUOTE]Zhanna написал:
Уважаемые технические писатели! Подскажите, когда нужно требование технологичности писать в ТУ (в ТЗ оно есть) и как можно осуществить проверку технологичности?[/QUOTE]
Посмотрите ГОСТ 14.201-83 "Обеспечение технологичности конструкции изделий"
Запись формулы определения максимального значения, Запись формулы определения максимального значения
 
Может так: [IMG WIDTH=257 HEIGHT=51]https://s8.hostingkartinok.com/uploads/images/2017/12/107fe5493a9f7b0b89afba108736b09f.png[/IMG]
скриншоты, показывающие последовательность шагов
 
Цитата
Vita написал:
Идея скриншотов хорошая, мне нравятся эти выноски. Но качество самой картинки потеряно.  
Не потеряно. Увеличьте масштаб отображения и увидите, что все скриншоты показываются в полном качестве, без потери единого бита.
В печатном варианте книжки все скриншоты прекрасно видны и разборчивы.

Щелкните мышью приведенный ниже рисунок и посмотрите.

Изменено: Виктор Фигурнов - 14.12.2017 06:53:20
скриншоты, показывающие последовательность шагов
 
Цитата
revo написал:
Но, при всем уважении к автору, дизайн скриншотов оставляет желать...
Флаг вам в руки. Сделайте лучше, результат опубликуйте на форуме. :)
скриншоты, показывающие последовательность шагов
 
Посмотрите книжку "1С:Бухгалтерия как на ладони", там множество хороших примеров таких скриншотов.
https://online.1c.ru/books/book/17203651/. Скачать можно бесплатно. Если боитесь запускать exe-файл, откройте его WINRAR-ом и извлеките PDF-файл книжки самостоятельно.
Сборка одного документа docx из нескольких
 
[QUOTE]Vita написал:
объединять можно через Рецензия - Сравнить - Объединить[/QUOTE].
Это другая функция, инструмент для объединения версий или исправлений одного документа Word, для нахождения различий и выборочного принятия или отклонения сделанных правок.

[QUOTE]tenek написал:
Одно из требований проекта - формирование из этих файлов единого документа docx ("большой").
От версии к версии при добавлении нового функционала правятся "маленькие" файлы. Затем вручную изменения переносятся в "большой" файл.
Хочется как-то автоматизировать этот процесс.
Первая автоматизация, которая пришла в голову - это Ctrl+C из "маленьких" файлов и Ctrl+V в "большой"  Но по каким-то причинам в ходе этой операции возникают проблемы - в "большом" документе "едут" стили (какие-то нумерованные списки становятся марированными, где-то самопроизвольно меняется уровень нумерованного списка).  В итоге куча работы и головной боли. Проблемы я связываю с тем, что файлы эти изначально живут чуть ли не со времён офиса'97.[/QUOTE]
Посмотрите здесь:
https://www.youtube.com/watch?v=fPAY61BgqJU
Примеры разработанной документации на MadCap Flare
 
Я когда-то делал документацию, потом без меня поддерживали и немного дополняли:

[B]Система «ФинГрад — Управленческий учёт»[/B]

http://www.fingrad.com/userguide/ru/index.htm - Онлайн версия
http://www.fingrad.com/userguide.pdf  - PDF версия
Помогите! Документ "Текст программы"!, Уважаемые гуру технических писателей, помогите, пожалуйста, составить документ "Текст программы"!
 
Цитата
gunslier написал:
А что делать. если у нас ПО - это образы виртуальных машин по 400 гигов? А заказчики требуют соблюдение НТД.
Любые капризы за ваши деньги. Распечатка 400 гигов это 160 миллионов страниц, что при стоимости печати 5 рублей за страницу составляет 800 миллионов рублей. Если ваш заказчик готов заплатить 800 миллионов рублей за соблюдение НТД, почему бы не удовлетворить его прихоть?
Возможно ли стать техническим писателем без знаний в IT области ?
 
Уже была аналогичная тема: https://techwriters.ru/forum/messages/forum607/topic19746/message10320/#message10320
Страницы: 1 2 3 4 5 6 7 8 9 10 11 12 След.

Рейтинг@Mail.ru