Обсуждение:Как составлять инструкции по снятию неоднозначности

Материал из OpenCorpora Вики
Перейти к: навигация, поиск

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

Раздел "Шаблоны для оформления инструкций" смешивает в кучу сразу много разнородных вещей, называя их единым словом "шаблоны".

Нужно понимать, что есть разные вещи:

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

Также в разделе упоминается стандарный тэги blockquote, который не является шаблоном.

У каждого шаблона есть инструкция на его странице, можно обстоятельно прочитать и понять, как он работает.

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

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

Собственно, сейчас плюс у этой крупной таблички один -- появляется центральная точка с кратким перечислением примеров, типа оглавление.

Беда в том, что для того, чтобы переделать -- нужно переделывать основательно. Подумаю, как это лучше сделать. Andrey Kruglov (обсуждение) 16:21, 30 ноября 2014 (MSK)

паттерны использования шаблона комментарий

Судя по табличке, Виктор когда создавал шаблон комментарий -- планировал его использовать только в конструкции "нажмите кнопку такую-то и подпишите комментарий такой-то".

Реальное использование шаблона гораздо шире, см. например инструкцию anim inan:

апостол как 'ученик Христа; последователь какой-нибудь идеи' -> одушевленное
апостол как 'книга' -> неодушевленное

Или ещё пример в другой инструкции:

Среди авторов Серебряного века - век (он, мой) -> мужской род
У вас интересная форма нижнего века. - веко (оно, моё) -> средний род

Соответственно, нужно как-то описать данный паттерн в примерах использования.

Andrey Kruglov (обсуждение) 17:43, 30 ноября 2014 (MSK)

В качестве исключения можно объединить инструкции

Вычеркнул фразу про "В качестве исключения можно объединить именительный/винительные в единственном и множественном числе, если существенная часть инструкции повторяется". Вот какая штука: только одна инструкция и была объединена (как раз именительный/винительный), однако когда я прошёл весь пул на множественное число и стал делать пул на единственное число -- оказалось, что пулы существенно разные по сложности, уговорил Светлану инструкции разделить. У множественного числа инструкция сразу стала короче наполовину. (А в инструкции по единственному числу, ох ещё придётся много чего добавить!)

Поэтому в целом я бы рекомендовал инструкции не объединять: лишних затрат не так много (копи-паста -- не сильно напрягающая мозг операция), а впоследствии всегда могут появиться ресурсы допилить обе инструкции под конкретное задание. Andrey Kruglov (обсуждение) 02:02, 28 января 2015 (MSK)