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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
Как обозвать описание создания нового объекта?
 
В очередной раз возник вопрос по именованию раздела руководства пользователя, в котором описывается создание какого-то объекта. С коллегами обсуждали дцать раз... интересно ваше мнение.

Вот, к примеру, формируем в программе аудиторный фонд учебного заведения. В БД нужно внести структуру из корпусов и находящихся в них аудиторий: создать перечень корпусов, а потом в них добавить записи о кабинетах.

Как лучше обозвать раздел руководства:

Создание корпуса
Создание записи о корпусе
или еще как-то?

С одной стороны, первый вариант лаконичнее, понятно, о чем в разделе пойдет речь, и т.д. С другой стороны, встречала мнение что "как-то не очень воспринимается заголовок типа "Создание корпуса", "Удаление аудитории"... Вроде как "вы же не физически удаляете объект, а только запись о нем из БД". И в тексте раздела звучит не очень "Чтобы создать корпус, нажмите на кнопку (выберите пункт меню и т.п.)" - вы же не дом строите...

Мысли по поводу второго варианта. Допустим, обзовем раздел "Создание записи о корпусе". Вроде все понятно со всех сторон. Но потом в тексте раздела придется постоянно тащить "Чтобы создать запись о корпусе... выберите запись о корпусе" и т.д. Придется для всех объектов писать "запись о..." Не многовато ли мусора, ведь изначально понятно, что мы не работаем в ПО с физическими объектами, у нас в любом случае только "записи о..." отсюда, по идее, не должно быть мыслей типа "Чтобы построить дом".

Какие формулировки вы используете в руководствах в подобных случаях?
 
Цитата
В БД нужно [b:2zj4k8wi]внести[/b:2zj4k8wi] структуру из корпусов и находящихся в них аудиторий
так и пишите - "внесение корпуса" :wink:
работаю в LibreOffice 4.1))
 
Цитата
В БД нужно внести структуру из корпусов и находящихся в них аудиторий: создать перечень корпусов, а потом в них добавить записи о кабинетах.
Классы: "Корпус", "Аудитория", "Кабинеты". У каждого класса есть свои атрибуты, часть атрибутов наследуемая с родительских классов, часть уникальны.

Цитата
как-то не очень воспринимается заголовок типа "Создание корпуса", "Удаление аудитории"... Вроде как "вы же не физически удаляете объект, а только запись о нем из БД". И в тексте раздела звучит не очень "Чтобы создать корпус, нажмите на кнопку (выберите пункт меню и т.п.)" - вы же не дом строите...

Мысли по поводу второго варианта. Допустим, обзовем раздел "Создание записи о корпусе". Вроде все понятно со всех сторон. Но потом в тексте раздела придется постоянно тащить "Чтобы создать запись о корпусе... выберите запись о корпусе" и т.д. Придется для всех объектов писать "запись о..." Не многовато ли мусора, ведь изначально понятно, что мы не работаем в ПО с физическими объектами, у нас в любом случае только "записи о..." отсюда, по идее, не должно быть мыслей типа "Чтобы построить дом".

Какие формулировки вы используете в руководствах в подобных случаях?
Можно сначала описать Классы, Объекты и их Атрибуты. При этом добавить описание в глоссарий и в раздел, описывающий требования к персоналу (там где пишется, что подразумевается владение терминологией БД, навыки работы с ОС Windows...)

Аудитория - это определенный объект, может иметь свои атрибуты (кол-во мест, площадь, номер и т.п.). Чтобы иметь возможность создавать такие объекты, надо создать класс в БД, у которого атрибутами буду также: кол-во мест, площадь, номер и т.п..  

Ну а далее выстраивается представление, что аудитория и корпус - это объекты, которые соответствуют записям в строках таблиц БД и т.п. И можно свободно писать "Удалите корпус" или "Создайте рай". Где-то в глубине документа можно периодически делать ссылки на описание таких классов, чтобы не "замыливалось" представление читателя о том, что интерфейс связан с БД.
 
Цитата

Как лучше обозвать раздел руководства:
Создание корпуса
Создание записи о корпусе
или еще как-то?

Первый вариант однозначно - Создание корпуса или м.б "[b:11tftzjt]Добавление корпуса[/b:11tftzjt]", но первый лучше.
Работаю по-старинке...
 
Цитата
Цитата

Как лучше обозвать раздел руководства:
Создание корпуса
Создание записи о корпусе
или еще как-то?

Первый вариант однозначно - Создание корпуса или м.б "[b:1hd2u326]Добавление корпуса[/b:1hd2u326]", но первый лучше.

Вот так пока и пишем.

Advanced, именно по такой схеме наши руководства и строятся. Может быть. не столь техничным языком (целевая аудитория не та), но всенепременно даем подводку, обозначая описываемые объекты, их взаимосвязь, хранение в БД, "зачем это нужно вообще" и проч.
А потом уже разделы типа Создать / Редактировать.

Спасибо за отклики :)
Страницы: 1
Читают тему