Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Оформление кода программы в документации
 
Собственно необходимо написать документ "Текст программы", но требований к оформлению самого исходного кода не нашла.
Подскажите плиз, как оформлять: шрифт, размер, отступы...
Спасибо!
 
Мы в своё время тоже таких требований не нашли, тогда во внутреннем регламенте согласно п. 2.2.3 ГОСТ 19.106-78 прописали, что исходный код оформляем шрифтом Courier New, 10. Зарегистрировали с тех пор не одно приложение, претензий никогда не было со стороны нормконтроля.

Что касается отступов, сохраняла форматирование исходного кода.
Изменено: Nadufka - 27.02.2014 17:00:10
Работать надо не 12 часов, а головой.
 
Спасибо!)
 
Возник еще один вопрос, есть ли требования к названию разделов в документе "текст программы"
Или название раздела должно совпадать с полным названием файла?
 
В документах, которые мы сдавали на регистрацию, был только титульник и, собственно, исходный код. Лучше уточнить у заказчика или нормконтроля, который будет принимать документы.
Изменено: Nadufka - 17.04.2014 14:21:05
Работать надо не 12 часов, а головой.
 
Цитата
Nadufka пишет:
В документах, которые мы сдавали на регистрацию, был только титульник и, собственно, исходный код. Лучше уточнить у заказчика или нормконтроля, который будет принимать документы.
Спасибо)
Заказчик говорит "как в ГОСТе", а там не оговорено)
 
Раз не уточняет, в каком ГОСТе, значит и сравнивать вряд ли будет )

Ну вот нашла ссылку . Там что-то говорится про РД 50-34.698-90, но по мне так это не совсем то.
Работать надо не 12 часов, а головой.
 
Еще смутно припоминаю, что при регистрации приложений юрист просила готовый документ, объемом не более 70 страниц (нашла какую-то памятку, во вложении, и вот еще ссылка).
Если это просто документ для готового заказчика, там может не быть таких ограничений.
Работать надо не 12 часов, а головой.
 
А вот без проверки вряд ли) Они к каждой запятой придираются и даже к цвету скриншотов   :)  

В общем, получается, что если файл называется "Test2.Recognition.prj\RecognitionConfiguration.cs"
То это и будет название раздела, а сам код согласно правил оформления на этом языке.
 
Цитата
Astica пишет:
Они к каждой запятой придираются и даже к цвету скриншотов
Бегите оттуда!!!       girl_witch_smile
Пусть гниют без вас
Изменено: ADVANCED - 17.04.2014 16:53:17
 
Вот читаю я сообщения уважаемого ADVANCED и завидую белой завистью )
Работать надо не 12 часов, а головой.
 
Цитата
Nadufka пишет:
Вот читаю я сообщения уважаемого ADVANCED и завидую белой завистью )
Чему именно?
Извиняюсь что не в тему...
На рынке труда очень много вакансий с различными условиями. Сайты с вакансиями называть не буду   read-smile  .
Никто вас не заставляет связывать свою жизнь с государственной конторой и получать 25 000 рублей в месяц   help-smile  .
В коммерческих организациях госты никому не нужны, главное понятность, доступность, грамотность, корпоративный стиль и т.п. И всякие должности типа нормоконтроля отсутствуют по определению, т.к. это не федеральный бюджет и каждая копейка ценна. Все на совести писателя без бюрократии. Есть куда развиваться профессионально и творчески   *writing*  . Вернуться в серое унылое здание с бабушками  на проходной  wall-smile   можно ближе к пенсионному возрасту       ;)
Изменено: ADVANCED - 17.04.2014 17:32:51
 
Видимо, не так много, раз форум пестрит вопросами типа "Помогите привести в соответствие ГОСТам", а не "Помогите сделать удобно" =)

В Москве таких вакансий много, в регионах меньше. Но дело даже не в этом. Я работаю в коммерческой организации, которой плевать хотелось бы на ГОСТы, если бы обязательность им соответствия не указывалась в ТЗ. А указывают их там либо сотрудники здания с бабушками, либо те, кому за свои деньги просто хочется чего-то понаписать там, а документация до лампочки. И вот таких вакансий большинство. Я их не оправдываю, я утверждаю, что, раз Вам повезло работать иначе - есть чему по-доброму позавидовать)
Работать надо не 12 часов, а головой.
 
Можем переместиться вболтовню
 
Текст программы оформляю так:

1. Наименование системы
Полное наименование системы: <>.
Условное (сокращенное) наименование: <>.
Условное обозначение: <>.
2. Версия системы
<>.
3. Текст программы
Исходные тексты программы доступны на установочном CD-диске, прилагаемом к документу.


Приклеиваю диск к документу ;)

Еще никто не делал замечаний по оформлению.
Если говорят, что надо в соответствии с ГОСТ... Я бы на вашем месте процитировала требование ГОСТ 19.401-78:

>2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.

В свою очередь, в ГОСТ 19.105-78 нет требований к шрифту ;)
techwriter.ru.com
 
techwriter, спасибо
С шрифтом чуть ранее разобрались, потом был вопрос про наименование разделов)  
 
))добавлю три копейки.

Собственно, исходный код на компакт-диске (мм...  мне кажется, что компакт-диск более удачное название, чем CD-диск) зачем нужен?

Честно говоря, сейчас вообще не понятно.
Т.е. если по внутренним стандартам хранение кода должно производится на компакт диске - тогда понятно (у нас - так)
Если нет, то это может быть сервер или облако))).

Далее.
Собственно, даже если весь код вы любовно запихаете на диск, то в общем его (исходный код) можно будет почитать.....
Для работы с ним (с исходным кодом) нужна еще всякая информация и всякие необходимые вещи.
Собственно, вот как все это нужное на компакт- диск запихать, да так, что  программисты спокойно восприняли - вот это у меня на повестке дня уже полгода стоит.  

Ежели принципиален шрифт, разделы - см. совет выше, где смайл с особой на помеле!

И еще вопрос. А как вы этот компакт-диск обозначаете/подписываете?
 
Цитата
'Фрося' Фроськина пишет:
Т.е. если по внутренним стандартам хранение кода должно производится на компакт диске - тогда понятно (у нас - так)
Если нет, то это может быть сервер или облако))).
Причем тут внутренние стандарты?
Текст программы - это эксплуатационный документ. Поэтому подразумевается, что передается Заказчику. На чем вы передаете программный код заказчику?
techwriter.ru.com
 
Цитата
'Фрося' Фроськина пишет:
Для работы с ним (с исходным кодом) нужна еще всякая информация и всякие необходимые вещи.
Собственно, вот как все это нужное на компакт- диск запихать, да так, чтопрограммисты спокойно восприняли - вот это у меня на повестке дня уже полгода стоит.
Не очень понятно, о какой ситуации вы написали.
И какие необходимые вещи нужны для чтения программистам?
techwriter.ru.com
 
Цитата
'Фрося' Фроськина пишет:
И еще вопрос. А как вы этот компакт-диск обозначаете/подписываете?
Подпись зависит от назначения и требований, по которым вы этот диск передаете. Если таких требований не существует, то они длжны быть регламентированы.
Обозначение - что имеется в виду? У каждого компакт-диска есть номер. Это и есть обозначение.
techwriter.ru.com
Страницы: 1
Ответить
Читают тему
Форма ответов
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить файлы
Отправить Отменить