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

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

 Зарегистрируйтесь
Форум » Пользователи » Виктор Фигурнов
Выбрать дату в календареВыбрать дату в календаре

Страницы: 1 2 3 4 5 6 7 8 9 10 11 ... 13 След.
Документирование интерфейсов, Документирование интерфейсов
 
Какие интерфейсы имеются в виду? Программные, аппаратные, пользовательские,  ООП-интерфейсы, или какие-то еще?
Порядок слов (и оформления в целом) титульного листа
 
ГОСТами это, слава Богу, не регулируется. В разных отраслях разные традиции. В конструкторской документации принято на титульном листе писать наименование, начинающееся с существительного. Например, "Игла швейная тонкая". А в строительстве иначе, например, Физкультурно-оздоровительный комплекс, Жилой комплекс "Простоквашино" и т.п.
Интервал между инициалами
 
Явно нигде не написано. В ГОСТах встречаются примеры и с пробелами и без.
Например, в типографском издании ГОСТ Р 7.0.5-2008 "Библиографическая ссылка" инициалы набраны с пробелами. А в текстовой версии того же стандарта -- без.
По правилам русского языка слова пишутся не слитно, а разделяются пробелами. Инициал с точкой это сокращение слова и поэтому тоже не должен писаться слитно.
Грамота.ру и Википедия рекомендуют писать через пробел:
[QUOTE]при наборе традиционных сокращений, а также инициалов имени и отчества, следует использовать пробел: т. е. (то есть), т. о. (таким образом), т. к. (так как), т. н. (так называем[ый]), и т. д. (и так далее), и т. п. (и тому подобное), до н. э. (до нашей эры).

Неправильно: и т.п., А.С.Пушкин
Правильно: и т. п., А. С. Пушкин[/QUOTE]
В русской типографике между инициалами и внутри сокращений типа "т. д.", "т. п." ставилась "тонкая шпация".
Современный аналог:  U+202F   narrow no-break space — узкий неразрывный пробел .
[CODE]HTML:  
LaTeX: \thinspace[/CODE]
Изменено: Виктор Фигурнов - 05.03.2022 10:45:44
Разработка Help, Разработка Help
 
[B]Sphinx[/B]: Python documentation generator
https://www.sphinx-doc.org/en/master/

[B]GitBook[/B]: a modern documentation platform where teams can document everything from products to internal knowledge-bases and APIs.
https://github.com/GitbookIO/gitbook

[B]Jekyll[/B]: Transform your plain text into static websites and blogs.
https://jekyllrb.com/

[B]DITA Open Toolkit[/B]: The open-source publishing engine for content authored in the Darwin Information Typing Architecture.
https://www.dita-ot.org/
Отступ абзаца по ГОСТ
 
Это цитата из "ГОСТ Р 2.105-2019". ОБЩИЕ ТРЕБОВАНИЯ К ТЕКСТОВЫМ ДОКУМЕНТАМ. Стандарт устанавливает общие требования к выполнению текстовых документов на изделия машиностроения, приборостроения и строительства.

[QUOTE]Абзацы в тексте начинают отступом, равным пяти знакам используемой гарнитуры шрифта [B](12,5-17 мм)[/B].[/QUOTE]
Автогенерация документации из кода
 
Кажется, что 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 2 3 4 5 6 7 8 9 10 11 ... 13 След.

Рейтинг@Mail.ru