info21 писал(а):
ScrollLock писал(а):
... написание технической документации проще, чем сочинения - не нужно понимание литературных персонажей, более простой и прямолинейный язык доков, нет пафосных вступлений и заключений.
Вот, наконец, золотые слова.
Не понимаю, где тут золото... Тем, кому не нтавится пафос - пусть не добавляют его во вступление и заключение. Но чем провинились сами начало и концовка? Ведь, также можно добавить, что между ними тоже полно пафоса, и дело закончится тем, что заказчик получит программный продукт и документацию - чистый лист бумаги.
Не помню, что говорили в школе насчёт введения для художественных произведений, но подозреваю, что именно то, к чему я пришёл спустя некоторое время после её окончания. А именно: оно устанавливает направление движения мысли автора, которое раскрывается в дальнейшем повествовании. Насчёт заключения, правда, не могу припомнить, когда оно в документации потребовалось бы.
Кстати, в документации по ББ есть вступления. Например, описывающие триаду Модель-Отображение-Контроллер. Или отступление, даже не знаю. Но без такого дополнительного объяснения данной триадой было бы пользоваться затруднительно. Обучение проходило бы по принципу проб и ошибок. Я понял, почему обращение к файлам настолько громоздкое, и почему нельзя было сделать более удобного способа только после прочтения той части документации, которая в мейнстриме содержит только пафос. Встречаются такие вступления как:
"Мы задумали новый проект. Однако мы всё крутились и крутились, однако никак и с места сдвинуться не могли. Так мы и сидели, пока меня не 'осенил' кирпич. Так, собственно, и зародился наш Супер Проект."
Однако, отказываться от проверенного веками элемента произведения толь ко потому, что последние лет 20 он только и делает, что отнимает время на прочтение из-за неумелого использования, всё-таки не стоит.
Далее, в школьную литературу попадают в основном произведения классиков, которые потому и стали классиками, что у них были хорошие мысли и они грамотно и доходчиво их передавали. Школьникам не приходится делать сверхусилий для понимания образов. Соответственно, сочинения не такая уж сложная штука (я говорю про сочинение как таковое, а не про очень хорошее сочинение). В случае же с документацией, вам предлагается стать этим самым классиком, чтобы грамотно и доходчиво передать способ использования инструмента, а не простое описание графического интерфейса. Чем грамотнее документация написана, тем реже в её придётся потом подсматривать.
Это я к тому, что хотя язык технических документов и проще, не стоит забывать о тех сложностях, которые подстерегают документописателя.
info21 писал(а):
Подозреваю, что такое упражнение имеет смысл даже с точки зрения обучения программированию самого по себе. Разбавить обезъянье тыканье в клавиши чем-нибудь напрягающим мозги.
Я даже могу кое-что предложить, но это будет не для 7 класса. Это поможет заставить уважать проектирование и поумерит пыл при "обезъянем тыканьи в клавиши". Как я заметил, программы, которым предшествовало проектирование, проще описать. Человек при проектировании описывал проект довольно простыми понятиями (для данного проекта), поэтому документация содержит довольно чёткие определения действий и описания процессов. Если же сначала был получен код, и лишь затем взялись за документирование, то понятия вычленять очень сложно. К тому же, они всё равно страдают невнятностью.
Упражненьице будтет состоять в следующем: на первом занятии класс делится на две группы. Первая группа проектирует, а вторая - пишет программу. На втором занятии (Когда оно будет? Через неделю?) все составляют документацию. На третьем занятии - вторые делают проект написанной программы, а первые - пишут код.
Тут важно, чтобы документацию оценивали как сочинение. Может, для этого выделить один урок русского языка? Так как проверяться будет всё: лексики до вложенного смысла.
Уже давно думал над над соотношением "художественного" и "практического"... на это натолкнуло ещё в юности замечание Марка Твена о "героях Толкового словаря"
(уже упоминал
в этом сообщении). И вот вопрос - по каким критериям оценивать [научно-]техническое писательство? И тут хотелось бы обратиться к заметкам Вениамина Каверина об "Альтисте Данилове" В. Орлова (кстати, 30-летие выхода этого романа в свет отмечалось недавно). Привожу выдержку с интервью, в котором он переходит от анализа этого произведения к анализу закономерностей художественного творчества:
Вложение:
Комментарий к файлу: Каверин В.А. Чтобы остаться...//в кн.: Письменный стол. - М.: Советский писатель, 1985.
Каверин-ЧтобыОстаться-инт(извл).djvu [80.31 КБ]
Скачиваний: 778
Как я вижу, Каверин тут даёт ответ - как же стать классиком НТ-писательства? - сам того не подозревая
Кстати, по изначальному образованию (и сфере интересов) он переводчик-арабист - т.е. не только литератор, но и языковед. Наверное, и из молодых многие знают его "Двух капитанов", цикл о Немухине и "Любителях Свежего Воздуха"
- но на тему науки и человека могу ещё отметить "Открытую книгу" и ещё более предметно - "Исполнение желаний" (как раз о поиске в филологии).
Для определённости ограничимся описанием готового решения (имеющим практическую направленность), что соответствует тематике конференции - публикации на тему НТ-поиска (включая научно-популярные) оставим в стороне (хотя сказанное в интервью принципиально приложимо и к ним). Исходя из тематики конференции, примеры будут из контекста Информатики-21... ну и визуализации знаний.
Итак, начнём по пунктам... но прежде уточним ещё вот что. Разбор Каверин провёл на НФ-произведении, и хотя большинство его заключений внежанровы, некоторые прямо апеллируют именно к этому жанру. Тем не менее я буду считать все их равно приложимыми к НТ-произведениям, и вот почему. Дело в принципиально неполной определённости для сочинителя ситуации применения описываемого научно-технического решения. По сути сочинитель всегда более или менее "научно фантазирует" идеальный процесс и результат применения - и это роднит НТ- и НФ-писательство. Сродство ещё усиливается, когда решение создаётся "наивным" образом, без должного обоснования - но и для полученных "убедительным" путём элемент неопределённости применения сохраняется.
Во-первых,
о композиции. Она существенно зависит от формы представления НТ-документа - натуральной или машинной (называю её "информатизованной"). В последнем случае у нас есть выбор - "классическое" или гипертекстовое построение. Отличие в представлении нелинейности - в первом это "пассивные" сноски к основному тексту и ссылки на места в том же/других документах, во втором - также и "активные". Специфика пользования вторыми в целом описана в руководствах по веб-дизайну. Однако есть и ещё плоскость выбора для любой формы - текстовая или графическая основа документа. Граф-натур-документы становятся всё более популярны - особенно как учебные пособия (типа "<то-то> в схемах и таблицах"; "структурированный конспект <сепульки>").
Отмечу, что сноски и ссылки, надо думать, никуда не деваются и из прогтекста - первые определяют "исключения", вторые - вызовы процедур (в т.ч. при обработке исключений и прерываний); если говорить о деклар-составляющей, то ссылкой является косвенная адресация элемента данных (операнда).Как может строиться граф-инфор-документ - изложил
в этом сообщении. Здесь же остановлюсь на композиции для документа на текстовой основе. Считаю, для читателя оптимально системное построение - сначала введение в базовые вещи - как начать/завершить использование (запустить/остановить систему-решатель, подготовить её к эксплуатации/длительному перерыву), затем введение в "мир" этого решения (сущностный состав и схему отношений, ограничивающие условия), далее практически значимые техоперации применения, и наконец - общие закономерности "выстраивания" техпроцессов для достижения целей (скорее всего, на конкретных примерах). При этом в модели "сущности-отношения" выделяются (но рассматриваются совместно) сущности декларативные (предметы) и императивные (действия).
Как пример можно рассматривать проекты описаний конкретных изделий - здесь и здесь.
Документ на гипертекстовой основе м.б. композиционно построен, допустим, так, как документация к ББ - однако это фактически система документов и главным в ней всё равно д.б. системное руководство - и прилагаемый шаблон пользовательской системы документов. Как построить такие шаблоны - известно из делопроизводства (там они называются "формуляр-образцами", объединяемыми в "унифицированные системы документов") - а в формуляр-образце также содержится оргметодчасть по редактированию. А руководство должно содержать содержательные указания по подготовке документов на базе шаблона пользователем - также на конкретном примере.
Видимо, в силу осознания этих обстоятельств в ББ введён документ Быстрый старт - именно его целесообразно развить в указанном направлении. А ББ-концепция информатизации документов "модель-вьюшка-контроллер", наверное, оптимальна (и даже адаптивна в смысле уровней технической эффективности) для этого.
Замечу, что в указанных документах мне не удалось провести этот подход целостно и законченно - именно поэтому называю их "примерами". В то же время для DesignIDEF в силу его "юзабилити" продвинуться удалось достаточно - к нему есть и контрольный пример. В Драконографике его не публиковал - там масса скриншотов, из-за чего будет слишком "весомым" - но по принципу похоже на ББ.БыстрыйСтарт.
В любом случае описание закономерностей синтеза как раз и должно утверждать необходимость "вырастания" более формального решения из менее формального (по иерархии Фридланда) и показывать, как можно "выращивать" (ту же программу в комплексе с документацией - из спецификации, а её, в свою очередь - из качественного описания задачи).
Во-вторых, о том,
с кем рядом д.б. мысленно НТ-писатель в ходе сочинения. Кто же у нас герой не художественного, а технического (документационного) произведения? А это снова человек - пользователь документируемой системы. Для его целей она создана, и для его удобства документируется. Понимание "характера персонажа" для данных целей дают начала педагогики и психологии (инженерной в первую очередь) - на это нужно сделать упор при обучении сочинителей.
В-третьих,
о лаконизме. НТ-сочинения практической направленности передают отчуждённое знание об "умениях делать", поэтому повторы в них неизбежны. В то же время системное изложение делает эти повторы целесообразными - сначала что-то лишь называется как элементы структуры "мира", затем атрибутируется и далее описывается развёрнуто. Если говорить о произведениях учебных и исследовательских, то они скорее формируют то самое критическое мышление, о котором говорил Н. Вирт.
В любом случае часто уместны (а порой необходимы) отступления от основного содержания документа - аналогично сноскам, но в тексте - некоторые из таких отступлений могут оставаться только в проекте документа (как элементы необходимого поля знаний). При ГТ-представлении их можно выносить на отдельные страницы; для "плоскотекстового" эргономично, очевидно, выделять оформлением абзаца и знака.
Для этого в УСД заложены стили вставок различного рода; элементы этой системы стилей используются и в данном сообщении (в меру предоставляемых возможностей форматирования).
При нормировании такого построения уже можно оценивать умение сочинителя выделять главное и второстепенное, основное и вспомогательное в содержании и быть лаконичным как на "главной сюжетной линии", так и на "побочных".
Лаконизм описания НТ-решения, очевидно, тесно связан с лаконизмом самого решения. Нарушение этого требования ("разбухание" описания) может иметь как негативный характер, так и позитивный. Второй связан с тем, что обычно объективно возможны как новые, не предусмотренные изначально назначения этого решения, так и иные способы решения (применения системы-решателя) для заданного назначения, чем первоначально найденные. При отработке и эксплуатации всё это постепенно выявляется, и законное желание этот опыт зафиксировать приводит к росту описания; здесь преодоление должно идти путём интеграции опыта в системное изложение - с одновременным распределением нового содержания по главной и побочным линиям. Негативный же прежде всего обусловлен сложностью описываемого решения; когда автор не позаботился о сокращении сложности системы, трудозатрат при решении - и описание будет отражать это (конечно, если оно составлено добросовестно, а не по принципу "коммерческой правды" - см. далее о пятом требовании).
В-четвёртых,
о работе над текстом. Понятно, что применительно к прогтекстам речь идёт об оптимизации - известное утверждение "всякую программу можно сократить на одну команду" можно считать частным случаем третьего и четвёртого требований Каверина
) В доказательном программировании справедливо считается, что ручная оптимизация прогмодели д.б. ограничена - переписыванием в исключительных случаях логически законченных фрагментов в СКИ (практически - на асмкоде) - о чём говорится и в описании ББ.
А вот в "человекочитаемой" части НТ-произведения требование Каверина полностью справедливо. Он не объясняет, зачем это нужно (имея в виду, что не чуждым литературы людям это д.б. понятно), но здесь всё же уточню - для точного, безошибочного выражения смысла произведения - а это требует даже от талантливого пера размышлений и поисков.
Замечу, что цели и формы написания художественного и технического произведений всё-таки разные, поэтому последние обычно не требуют таких трудозатрат. Так, книги по АиСД-Оберон и по КП я бы полагал необходимым "переписать" не более одного раза - и то первую практически лишь для исправления ошибок корректуры (которых, кстати, заметил гораздо меньше, чем во второй). А вот, скажем, Справку Тышова следовало бы переписать раза два - причём первый раз в буквальном смысле, чтобы использовать рационально и удобно возможности организации содержания, предоставляемые ГТ-формой, на системной основе...
В-пятых,
о границах фантазии. И здесь прежде всего выделю два типа НТ-сочинений по целям обращения - "технические" и "коммерческие". Ясно, что вторые пропагандируют предмет описания (средство/полезную модель) - но и в них следует ставить "железные логические границы" - рассуждениям о предметной области и свойствах решения. Иначе вместо объективной и даже "коммерческой" правды создаётся НТ-миф.
Здесь имеется в виду следующее определение "коммерческой правды", сформулированное в практике западного бизнеса: "Всегда говорите правду. Говорите много правды. Говорите гораздо больше правды, чем от вас ожидают. Никогда не говорите всю правду." (Смеляков Н.В. Деловая Америка. (Записки инженера). 2-е изд. - М.: Политиздат, 1970. - с. 110.).
Уже упоминал о сути НТ-мифа здесь, но не вредно будет повториться - если нужно уточнить для себя это понятие, возьмите книгу Ю.П. Фёдорова "Справочник инженера по разработке АСУТП" (М.: Инфра-Инженерия, 2008) – и посмотрите, как на с. 34...50 он определяется и развенчивается (ещё один пример там же касается гарантоспособности IP-технологий и других с недетерминированным доступом к среде для РВ-коммуникации - где-то на с. 70...80).
Когда автор НТ-текста утверждает, что "описываемое решение позволяет делать, что хочешь" - это вызывает те же вопросы, что и к тексту художественному, где "мышь превращается в чернильницу, а курица - в помойное ведро"
Притом заметим, что для понимания, что "если можно всё - то нельзя ничего", совсем не обязательны таланты и развитие Каверина - обычно вполне достаточно здравого смысла.
Вполне понятно, что в сфере формализации это относится и к ЯПЗ. Очевидно, именно действием этой закономерности обусловлено формирование семейства языков на базе Оберона.
В видах сопряжения с современным доказательным программированием, наверное, следует также обратить внимание на устанавливаемые для информодели и её языка ограничения доказательной, информатизуемой верификации, изложенные у Карпова. Имеется в виду альтернатива между употреблением текстуально конечных типов (модель автоверифицируема, но м.б. ограничено несоответствием задаче) и неконечных (возникают не только проблемы автоверификации, но и представимости решения для его прослеживаемости вручную - об этом говорил Илья, см. в этом сообщении). В смысле прослеживаемости шаг сделан в книге о КП - при описании указательных типов и их использования в неформальном введении.
Даже если предполагается крайне широкий круг применений решения - всегда нужно структурировать этот круг и рассматривать конкретные примеры (по одному хотя бы для каждого выделенного назначения) - и контрпримеры, на которых показываются увиденные сочинителем ограничения.
Как это ни удивительно, но контрпримеры-то как раз больше будут способствовать совершенствованию решения, чем дифирамбы - сокращая пользователю и вообще человеку думающему дорогу к началу творческого развития предмета, давая необходимую "пищу для ума" (и создателю решения тоже). И они могут входить как раз в заключение.
В-шестых,
о прозе и поэзии. Вроде бы это не приложимо к "сочинениям на формальные темы"? Ан нет - только надо уточнить, что речь идёт о жанре и стиле произведения (и прежде всего текстовой основы его). И выбор стиля НТ-текста также диктуется любовью к герою-пользователю, стремлением глубоко понять его.
Формальность же НТ-предмета делает принципиально возможным выделение ограниченного набора стилей. Жанры условно могу подразделить на "серьёзный", "лёгкий", "фольклорный".
Здесь опираюсь на общепринятую классификацию художественных (впервые встретил её у замечательного отечественного музыковеда Льва Мархасёва в его популярной работе: Любимые и "другие". - М.: Детская литература, 1975).
Условность же связана с тем, что жанры и стили находятся в тесных системных отношениях. Так, в языкознании принята трактовка: "Ещё римские грамматисты создали учение о трёх стилях - возвышенном, умеренном и простом. Эти стили связывались с определёнными предметными областями... Эта теория была пересажена на русскую почву Ломоносовым, который... связал теорию языковых стилей с теорией литературных жанров. <...> Если в античности и у Ломоносова эти стили имели объективное основание в самом предметном мире, то сейчас они субъективизировались; ...сейчас мы в принципе о всякой вещи можем высказаться торжественно, нейтрально или презрительно, пользуясь при этом теми же средствами, на которые указывал Ломоносов. Объективные же основания стилей теперь иные; они... не находятся в иерархических отношениях." (Камчатнов А.М., Николина Н.А. Введение в языкознание. - М.: Флинта: Наука, 2006. - С.177...178.)
Возможную конкретизацию взаимосвязи стилей и жанров для НТ-сферы можно увидеть также в классификации: Пособие по научному стилю речи./Под ред. И.Г. Проскуряковой. - М.: Флинта: Наука, 2006. - С.7.Первый жанр общепринят в НТ-среде - всё излагается нейтрально (и безлично), неэмоционально и даже сухо; сочинитель м.б. "строг" к читателю; может педалироваться значимость излагаемого, придаваться пафосное звучание - так, сказать "высокий штиль".
Второй характерен для обращения к неспециалистам - апеллирует к их незнанию, естественным чувствам и образцам поведения - потому можно ещё назвать "свой в доску"; также м.б. и "игривым".
Третий не обходит знание, в т.ч. профессиональное, но использует больше эмпирические и/или "апокрифические" его элементы и потому в средствах выражения тяготеет ко "вседневности", "живому общению" с читателем; характерен, когда пишется о новом и/или "хорошо забытом старом".
Каждый жанр и стиль возможен - только в разных ситуациях и умеренно употреблённый. В принципе возможно и смешение стилей - но и в этом случае каждый стиль д.б. выдержан, как и в случае единственного.
В то же время можно выделить и ещё одно измерение содержания произведения - по соотношению текста и подтекста, т.е. явного и скрытого смыслов. С этой т. зр. можно определить такие варианты, как:
* "бесхитростный" - текст не несёт подтекста в силу того, что сочинитель не преследует скрытых целей и/или умеет изложить весь смысл явно; применительно к НТ-практике, если имеется в виду неопределённость "предметки" - о ней так и говорится, определённость также очевидна. Для этого естественный язык изложения д.б., как говорят, ограниченным, или структурированным, т.е. с разрешением неоднозначностей, "ловушек".
* "двусмысленный" - содержит подтекст, вполне очевидный подготовленному в "предметке" и языково развитому читателю; достаточно уметь читать "между строк", чтобы извлечь полный смысл; может возникать непреднамеренно как результат неумения/нежелания сочинителя "вытаскивать на свет" весь смысл, ограничивать язык.
* "адаптивный" - рассчитан сочинителем на то, чтобы скрытый смысл извлекался сознанием читателя помимо его воли; для этого обращается "из междустрочья" к закономерностям восприятия данных, так сказать, "лезет в душу", используя знания и методы "спецпропаганды"; при этом и явно-стилевые средства (включая композицию стилей) направляются на это.
Во втором и третьем случаях обращение, как ещё говорят, "синхронизуется" с априорно известными (а при интерактивном общении - также с опытно выявляемыми) установками мышления.
Хороший пример "адаптивного" стиля, как уже где-то здесь упоминал, - сочинения В. Резуна (конечно, для корректной интерпретации "и текста, и подтекста" при этом также изучаются работы по разбору использованных механизмов "адаптивизации" - в данном случае хороши А. Помогайбо и В. Грызун - возможно, имеет смысл прочесть после предмета разбора).
Теория "адаптивного" построения удачно изложена у Г.Г. Почепцова; в видах "укрепления неокрепших душ", возможно, именно с такого материала и надо начинать знакомство с этим стилем.
Выдержки из указанных работ можно найти в этом соообщении.
"Адаптивный" или "двусмысленный" вариант порой так же уместен, как "бесхитростный" - если не забывать утверждения Паронджанова, что "человеческий мозг нужно грамотно проектировать" (Как улучшить работу ума, Гл.20). Фактически при этом имеется в виду "дружественная адаптивизация" формы произведения явно предопределёнными средствами и способами, заранее объявленная "полисемантизация" для отдельных случаев (обычно в интересах того же критического восприятия предмета).
В качестве примера можно снова сравнить книги Вирта и Потопахина. Стиль второй, пожалуй, можно определить как "фольклорный". Очевидно, это определяется пониманием целевой аудитории. Если отвлечься от "правильнописания", стиль выдержан; наверное, его даже можно усилить для пользы дела. В то же время возможны замечания по качеству изложения; это отдельная тема.
Представляется очевидным, что первая книга написана строгим стилем. Можно отнести это только на счёт позиции Вирта, но это вряд ли точно - естественные языки часто несоизмеримы, и переводчик до известной степени должен "пересоздать" мир автора на языке перевода. Оправдано ли это, не стоило ли облегчить, учитывая известную сложность предмета? Думаю, оправдано - именно в видах "грамотного проектирования" - стиль со своей стороны настраивает на дисциплину ума.
А вот бесстильность не свидетельствует о качестве НТ-сочинения - и это в известной мере реплика в сторону той же Справки Тышова. Не стоит строить творчество на формальные темы исключительно на "потоке сознания" - и если это даже естественно происходит в силу недостатка возможностей сразу "и делать, и описывать" - следует выделять время для постобработки описания.
Скрытый смысл при формализации также связан с текстуально не конечными структурами.
В-седьмых,
об основной задаче применительно к НТ-литературе. И технический писатель, думаю, должен также своими произведениями доказывать высокое мнение о человеке - герое своего сочинения. Увы, зачастую НТ-сочинитель (и в частности, в сфере ИТ) в принципе невысокого мнения о пользователе - откуда же этому взяться... чего нет, то не воплотишь
Очень важно, чтобы произведение будило воображение, в т.ч. и "бедное", звало к творчеству - и здесь помогают все вышеперечисленные факторы - и композиция, и стиль, и логика, и понимание читателя... Однако это, безусловно, может опираться только на "минимально расширенный код" читателя (в смысле, раскрытом
в этом сообщении).
И существенно замечание Каверина о неразрывной связи идеи произведения и его формы, о том, что одно не должно превалировать над другим - и в частности, форма д.б. передовой. Вот здесь вновь могу указать на необходимость более широкого употребления визуальной формы - для чего пока что нужно ещё искать (и находить
) ряд её аспектов.
Вот из таких соображений, думаю, стоит оценивать "технические сочинения".
Очень сильное подозрение есть, что уроки языка/литературы под это дело в школах/ссузах не выделишь - поэтому придётся всё делать на информатике - как составляющую выполнения проекта. В профобразовании есть ещё одна потенциальная возможность - часто в программу заложены курсы типа "введение в специальность", "основы НТ-творчества" - можно начала НТ-писательства внести туда... Разумеется, это возможно при подходе "поверх программы"
И наверное, ничто не может заменить чтения хорошей литературы - в данном контексте также и научно-популярной, и художественной. Особенно если изначально способностей недостаточно - поможет развиться. "Хорошая", как правило, значит - не слишком новая - увы, сегодня редко встретишь достойно написанную популярную книжку... В то же время в смысле "проектирования работы ума" в НТ-сочинении нужно как раз пользоваться современными выразительными средствами, начиная с КогниСтиля.
Вход
FAQ
Поиск
