Клуб технических писателей

Глоссарий

widder3
14 мая 2015, 15:49

Коллеги, Привет!

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

 

Так вот, хотелось бы узнать, когда Глоссарий будет опубликован

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

 

 

 

7 комментариев

Коллеги, глоссарий очень важный раздел... но... как думаете, позволяют сегодня те или иные средства разработки сделать глоссарий готовых конструкций? Как это я себе представляю: Вы начинаете описывать фильтр, нажимаете на кнопку вставки сниппета, переменной или OLE-объекта, появляется перечень стандартизированных фигур описания, выбираете нужный элемент и все... В Ваш топик была вставлена заготовка, например:

"Фильтр предназначен для... и позволяет...
Для использования фильтра:
1. Нажмите на кнопку ... на панели инструментов.
2. На закладке ... заполните следующие поля:
...
10. Чтобы применить фильтр, нажмите на кнопку ... на панели инструментов."
Вместо пропусков вставляете нужные значки или наименования...
Никто такие вещи у себя не использует в работе?

Александра Ласточка
7 июля 2015, 12:09

Ох, было бы очень здорово такое использовать.

Но наши коллеги и дельфисты, и вижл-сишники такое давно используют, правда в виде вставки функций и т. д. :) Такие же вещи позволяет "вытворять" и XML-редактор Oxygen... Вот только готовые текст-конструкции... как их "прошить" в нужный софт...

Здавствуйте, 

а что все-таки с глоссарием? очень бы хотелось его посмотреть!

Мы думаем над тем, в каком формате и объеме выкладывать информацию из гайда.
Следите за новостями клуба :)

Юрий, спасибо, будем следить

Надеюсь, у вас будет время знаяться этим вопросом и вы нас скоро обрадуете :)

Очень ждем, спасибо вам (love)