Всем привет. Подскажите, пожалуйста, как правильно оформлять вставки кода в

Question

TechWriters.ru - technical writers (технические писатели)

Всем привет. Подскажите, пожалуйста, как правильно оформлять вставки кода в

Word? Может есть какие-то конкретные требования? А то встречал много разных вариантов - и другим шрифтом, и с серым фоном, и с рамкой, и с номерами строк, и с выделением цветом, а как правильно нигде найти не могу.

0

13.11.2023

7 ответов

24 просмотра

Андрей TW

Зависит от того, как и кто проверяет доки. Мне встречалось, что просили оформить все фрагменты кода через рисунки. Подписывать это дело как "Листинг". Т.е на рисунке таком-то приводится листинг кода по..... . Вот так хотел эксперт из министерства. Это был самый трудоемкий вариант. А в остальном в зависимости от документа встречали разные варианты в тексте word. Стоит обратить внимание на то, нужно ли пользователю копировать эти строки с кодом. В инструкциях по API это нужно, значит фрагмент должен копироваться и т .д.

0

13.11.2023

Александр Мокрушин

а еще хорошо, когда есть подсветка кода

0

13.11.2023

Ekaterina Krasiuk

Гостовских требований нет Лучше на берегу согласовать с нормоконтролером заказчика

0

13.11.2023

Ekaterina Krasiuk

Александр Мокрушин
а еще хорошо, когда есть подсветка кода

При распечатке документа все эти подсветки выглядят уныло, Качество как правило отвратительное, Расходуют слишком много краски

0

13.11.2023

Александр Мокрушин

Ekaterina Krasiuk
При распечатке документа все эти подсветки выглядя...

требования для печати - это отдельная история подсветка хороша для разработчика, который будет документацией пользоваться для решения своих задач

0

13.11.2023

Рубен Абрамов

Я обычно оформлял как приложение по ГОСТ ЕСКД или ГОСТ ЕСПД. Если требовались куски кода в тексте, то вставлял скриншоты и ссылался на них, как на рисунки. Конечно, подсветка кода в теле документа тоже хорошо повышает читабельность. Этот вопрос лучше всего согласовать с НК заказчика, здесь я согласен с Екатериной.

0

13.11.2023

Luiza · Accepted Answer

Luiza

Правильно так, как решите оформлять в компании в своём стаилгайде так сказать. Единых правил для всех нет.

0

13.11.2023

Похожие чаты

Всем привет. Подскажите, пожалуйста, как правильно оформлять вставки кода в

7 ответов

Похожие вопросы