2 что такое справочные руководства

Edit me

Краткое справочное руководство выполняет иную функцию, нежели руководства по началу работы. Хотя руководство по началу работы помогает новичкам ориентироваться, предоставляя сквозную инструкцию для выполнения простого запроса API, краткое справочное руководство помогает пользователям получить представление о системе в целом, часто путем предоставления списка конечных точек API.

Необходимость в кратких справочных руководства

Будь то документация для конечного пользователя или документация для разработчика, в кратком справочном руководстве содержится 1-2-страничное руководство, где кратко описаны основные задачи и функции системы.

guide

Краткие справочные руководства содержат ключевую информацию, сжатую в краткий формат для удобства использования

Краткое справочное руководство должно предоставить пользователю достаточно информации, чтобы понять суть системы, включая ключевые конечные точки и задачи. Часто конечные точки API имеют связь друг с другом, которые можно изобразить визуально. Вот пример диаграммы API, которую автор курса создал для одной из компаний:

acme

Формат краткого руководства

Текст в диаграмме приведен на латинице по соображениям конфиденциальности, поэтому логика может быть не совсем очевидной. Но в этом API конечные точки организованы в разные группы. Некоторые из групп имели несколько уровней в конечной точке, и несколько опций включения для каждой конечной точки. Диаграмма была создана в Adobe Illustrator и опубликована в формате PDF. Разработчики сочли такой формат полезным, потому что был охвачен API в целом, показав, как все конечные точки соединены друг с другом в логической гармонии. Для документации API обычное дело, что в кратком справочном руководстве перечислены сокращенные описания конечных точек. По этой причине вывод Swagger UI часто может служить кратким справочным руководством.

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

acme

Такой формат краткого справочного руководства больше ориентирован на задачи, чем на конечные точки API

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

Преимущества чистой информации для изучения

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

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

Благодаря такой “чистке” быстрые справочные руководства предоставляют пользователям уникальное преимущество в понимании материала. Предоставление общего обзора системы помогает пользователям получить представление целого, до углубления в детали.

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

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

Задача, вероятно, невозможна для технического материала. Тем не менее, попытка того стоит, и философия остается прежней. Краткие справочные руководства научат нас пользоваться системой за 5 минут, а не за 5 часов. Это философия упрощения и языковой эффективности.

Не стоит обманываться краткостью и масштабом краткого справочного руководства. При разработке такого руководства можно потратить несколько дней на написание только одной страницы. Но когда финал может быть отлит золотом!

Примеры краткого руководства

Ниже приведены примеры кратких справочных руководств на различных сайтах документации по API.

Eventful

Краткое руководство Eventful

Eventful предоставляет быстрый список всех конечных точек в API на одной странице, упорядоченный по группам ресурсов. Каждая конечная точка описана примерно в половину строки, поэтому можно быстро понять их все. Например, описание для /events/get в их кратком справочнике: «Получить запись о событии». Но если щелкнуть для получения более подробной информации, более подробное определение будет «При наличии идентификатора события возвращает данные о событии, связанные с этим событием». , См. http://eventful.com/events/E0-001-000278174-6 для примера интерфейса».

С первого взгляда на конечные точки можно получить определенное понимание. Взглянув с высоты на лес, можно увидеть форму леса в целом. Можно не знать, какие деревья содержит лес, но можно понять другие детали, которые не видны, когда видишь одно дерево.

Parse

Краткое руководство Parse

Краткий справочник Parse похож на Eventful в том, что это длинный список конечных точек, на этот раз сгруппированный в таблицы. Эта справочная страница является просто разделом в одной длинной single page странице документации. При их подходе вся документация находится на одной странице, но при прокрутке вниз выделяются разные записи на боковой панели.

Иногда разработчикам нравится одностраничный подход, потому что он уменьшает фрагментацию информации и позволяет им использовать Ctrl + F, чтобы найти все экземпляры ключевого слова. Исследования компромиссов такого одностраничного подхода описаны в Single-page docs versus “Click Insanity”.

При использовании справочной документации OpenAPI на GitHub, заметно, что документация также содержится на одной странице. Разработчики могут использовать Ctrl + F, для быстрого поиска. Тем не менее такая документация обеспечивает много визуальной сложности для понимания пользователям.

Shopify

Краткое руководство Shopify

Краткое руководство Shopify не про API, но оно показывает фильтры, переменные и другие функции, доступные в Liquid, который является языком сценариев для разработчиков. Здесь Shopify использует функциональность свертывания и расширения для сжатия информации.

Такое краткое справочное руководство удобно тем, что позволяет одновременно просматривать все доступные функции в Liquid, чтобы знать, что нужно для получения дополнительной информации. Это как карта местности Liquid. Карта позволяет узнать все существующие функции.

👨‍💻 Практическое занятие: краткое справочное руководство

В своем найденном опен-сорс проекте найдем краткое справочное руководство. Ответим на следующие вопросы:

Существует ли краткое справочное руководство по API? Возможно, список конечных точек API?
Есть ли вывод Swagger UI, который служит кратким справочником по API?
Если нет краткого справочного руководства, выиграет ли API от этого? Почему да или почему нет?
Помимо списка сокращенных описаний конечных точек, что еще можно добавить в краткое справочное руководство API? Общие задачи?
Есть ли несколько важных задач, которые пользователи должны выполнять с помощью API? Обсуждаются ли эти основные задачи в руководстве по началу работы?

🔙

Go next ➡

Источник

Техническое нормирование работ по испытанию скважин (Справочное руководство). М., Недра, 1977. [c.182]

С т а с к е в и ч Н. Л. Справочное руководство по газоснабжению. Л., 1960. 875 с. [c.354]

Стандартизировать обработку грузовых единиц на предприятии позволяет применение внутрифирменного справочного руководства по таре и упаковке, в разработке которого должны принимать участие все заинтересованные службы. Основу руководства может составлять следующая информация [c.404]

Более подробно порядок выполнения операции деления описан в специальных справочных руководствах. [c.9]

При заполнении накладной экспедитору надлежит пользоваться Алфавитным списком железнодорожных станций (книга 2) Тарифного руководства №4, Единой тарифно-статистической номенклатурой грузов в разделе Б части 1 Тарифного руководства №1 и частью 2 этого Руководства Прейскуранта №10-01 для расчета провозной платы, а также знать статистические коды обслуживаемых грузоотправителей и грузополучателей, иметь под рукой справочные руководства грузоподъемности подвижного состава, степеней негабаритное , принятых сокращений по видам упаковки и др. [c.165]

Финансово-кредитный словарь в двух томах представляет собой справочное руководство по всем отраслям финансовой науки и практики. Он предназначается для широкого круга работников финансовой системы и кредитных учреждений, для финансистов, экономистов-плановиков и бухгалтеров предприятий, совнархозов, министерств, ведомств и других советских и хозяйственных организаций, для преподавателей и студентов высших и средних экономических, финансовых и кредитных учебных заведений. [c.3]

Данная глава является кратким обзором терминов, которые вы, возможно, слышали в применении к техническому анализу. Необходимо ли вам их знать Не сейчас. Считайте это лишь кратким справочным руководством. [c.244]

Приемы и методы финансового анализа постоянно меняются и совершенствуются, для того чтобы соответствовать требованиям динамичной инвестиционной среды. Учебный курс и программы экзаменов также все время обновляются для отражения последних достижений аналитической теории. После утверждения кандидатуры соискателя звания FA ему отправляют Учебное руководство, содержащее детальный список литературы для изучения. Вся программа основана на домашнем изучении, и Институт формально не проводит никаких учебных занятий. Однако он совместно с координаторами учебных программ FA региональных обществ аналитиков или с колледжами и университетами организует учебные группы. Для того чтобы помочь кандидатам в обучении, Институт периодически публикует справочные руководства, учебники и списки рекомендуемой литературы. [c.938]

Книга Ф. Никсона представляет собой справочное руководство практически по всем аспектам обеспечения качества и надежности. [c.13]

Справочное руководство. В справочном руководстве подробно описаны все внешние характеристики программного изделия. Оно обеспечивает пользователя подробной информацией о назначении программного изделия о необходимом оборудовании и его конфигурации о языке программирования, включая форматы команд и сообщений, структуры входных и выходных данных о взаимосвязях с другими программными изделиями. При этом предполагается, что читатель справочного руководства имеет опыт работы с техническими и программными средствами ЭВМ. [c.139]

Справочное руководство составляется на основе внешней спецификации. Дополнительные исходные материалы представляет группа разработки. Это руководство предназначено для программистов или системных аналитиков, которые являются непосредственными пользователями программного изделия. Предполагается, что они имеют опыт работы на ЭВМ по-крайней мере в течение одного года. [c.139]

Справочный буклет. Справочный буклет имеет карманный формат и содержит краткие сведения из справочного руководства. Он позволяет быстро ознакомиться с форматами операторов, мнемоникой операций, таблицами преобразования кодов, синтаксисом языка. В наиболее сжатой форме этот документ называется также справочным формуляром. [c.140]

Группа выпуска документации начинает участвовать в работе над программным изделием в рамках фазового обзора I, выполняя предварительную оценку стоимости издания документации. Для этого приходится принимать некоторые предположения относительно вида документации, времени издания и расценок. Чем определеннее составлены стандарты оформления документации, тем точнее окажутся оценки, полученные в этой фазе. Если, например, для транслятора с РПГ решено выпустить справочное руководство, руководство оператора и указатель сообщений, то этого уже достаточно, чтобы более менее точно рассчитать затраты на выпуск документации. [c.141]

Независимо от того, насколько хорошо все сотрудники понимают методы работы, принятые в их организации, среди сотрудников во взглядах на производственные задачи не будет до конца того единодушия, которое требуется для выполнения каждого конкретного задания. Создание универсального программного обеспечения, предназначенного для неизвестных режимов работы, является слишком сложным делом, чтобы множество людей имело одинаково полное представление об изделии. Им необходимы справочные руководства. [c.328]

Даже если какой-то сотрудник правильно представляет организацию собственной работы, ему довольно трудно будет ясно изложить свои замыслы коллегам, если не упорядочить эти замыслы тем или иным способом. Для этого также необходимы справочные руководства. [c.328]

Техническое описание системы Справочное руководство Справочный буклет Руководство оператора Указатель системных сообщений [c.346]

Ковелю Дж. А. Бизнес-планы. Полное справочное руководство. — М. Бином, 1999. [c.228]

В последнее десятилетие необходимым условием успеха любых организаций, от коммерческих до некоммерческих (благотворительных обществ, больниц и университетов) было признано повышение эффективности маркетинга. Но, несмотря на это, до сих пор отсутствует четкое понимание его сущности, методов и границ. В самом деле, многие предполагаемые последователи этой науки ошибочно отождествляют две далеко не главные функции маркетинга — рекламу и продвижение товара — с концепцией, связанной с созданием взаимовыгодных отношений обмена. И любое авторитетное и всеобъемлющее справочное руководство, подобное этому, должно служить разрушению заблуждений, так же как и давать столь необходимое руководство в области понимания сущности, методов и границ маркетинга. [c.12]

Эта книга не только представляет и описывает все внутренние особенности японских свечей, но в дальнейшем может служить и справочным руководством. Каждая модель свечей будет определена и описана в стандартной форме, так что вы сможете быстро получить необходимую вам справку. Я представлю новый метод анализа, называемый фильтрацией свечей , который, по моим наблюдениям, чрезвычайно полезен для лучшего распознавания моделей. Вы увидите, что популярность его растет, поскольку он являет собой надежное основание для последующего анализа и исследований. [c.14]

Франсуа А. Справочное руководство по вопросам организации Пер. с франц. В 2 т. — Париж, 1985. — Т. 2. [c.130]

Франсуа А. Р. Справочное руководство по вопросам организации В 2 т. Пер. с франц. — Париж, 1985. [c.229]

Книга, таким образом, является и предметом системного изложения важной области знаний и методов, и справочным руководством для специалистов, и учебным пособием для желающих продвинуться в этой области деятельности, [c.12]

Иначе, однако, обстоял вопрос в отношении цен. Согласно объявленному ОПЕК намерению установить твердый уровень справочных цен примерно на 40% выше рыночных, чтобы восстановить, как заявляла ОПЕК, старое соотношение 1 к 1,4 между рыночными и справочными ценами, цену на 1974 г. надо было установить на уровне примерно 25 долл. за баррель, тогда как всего лишь три года назад она составляла 1,6 долл. О такой цене явно не могло быть и речи, но в декабре 1973 г., когда члены ОПЕК собрались для обсуждения создавшегося положения, у них не было единой позиции. Некоторые из них, например Саудовская Аравия, считали, что производители не должны извлекать слишком большие коммерческие выгоды из искусственно созданной нехватки, вызванной в основном политическими соображениями. Другие же, Иран, Ирак и Алжир, которые сильнее нуждались в доходах, считали драматическое повышение цен в порядке вещей. Наконец, опять-таки под руководством шаха, было принято окончательное решение снова повысить цены вдвое на основе простого принципа обеспечения отчислений в пользу стран-производителей, эквивалентных стоимости добычи нефти из сланцев. Таким образом, страны-потребители, и без того уже глубоко встревоженные политическими последствиями ограничений на поставки нефти, внезапно столкнулись с таким повышением цен на нефть, которое превзошло их худшие опасения, —повышением, [c.280]

ТЕХНИЧЕСКОЕ нормирование работ по испытанию скважин. Справочное руководство. 16 л., 1 р. Авт. Сомова М. С., Шкляр М. Г., Горячев Б. И., Акопян А. С. [c.232]

Ковелло Дж. А, Хейзелгрен Б. Дж. Бизнес-планы. Полное справочное руководство. Перевод с англ. — М. Лаборатория базовых знаний, 1999. [c.860]

В справочных руководствах, в принципе, имеются указания и методики гидравлического расчета входных участков косогорных труб. Как правило, в них отмечается, что конструкции с криволинейными боковыми стенками, вызывающие слабые деформации свободной поверхности, имеют чрезмерно большую протяженность. Поэтому рекомендуются и входные участки с плоским дном и ломаными боковыми стенками. В их пределах образуются косые волны, которые взаимопересекаясь и отражаясь от стенок, проникают в водопропускную трубу и распространяются в, ней на значительном протяжении. При значительных углах сужения бурного потока в плане наблюдается либо образование прямых прыжков, либо продольных гребней, глубина виды в которых в 6 много раз[превышает с глубину потока в конце быстротока. Иногда она может превышать1 высоту тр убы, что угрожает разрушением насыпи. [c.180]

Скоростная обработка металлов резанием, Справочное руководство, ВПТИ, 1954. [c.273]

Годфруа Ж. Что такое психология в 2-х т. Т. 2. — М. Мир, 1992. С. 58. О надежности и валидности тестов см., например Клайн Пол. Справочное руководство по конструированию тестов. — Киев, ПАН Лтд, 1994. Иванцевич Дж., Лобанов А. А. Человеческие ресурсы управления. — М. Дело, 1993. С. 224-225. [c.180]

В первом томе восьмитомного учебно-справочного руководства Общие сведения о нефти и нефтепродуктах [c.7]

В. Г. Афонин, Л. М. Гейман, В. М. Комир. Справочное руководство по взрывным работам в строительстве (Киев Буд1вельник , 1974 г.) и др. [c.283]

Примечание. Непараметрические ранговые методы за последнюю четверть века зарекомендовали себя как бурно развивающаяся область математической статистики. Эти методы в силу своих преимуществ над традиционными применяются не только в экономико-статистических расчетах, но и при обработке данных в естественно-научных, инженерных, медицинских, космических и многих других исследованиях. На русском языке основы теории ранговых методов представлены книгой Я. Гаека и 3. Шида-ка, справочным руководством М. Холлендера и Д. Вульфа, моно- [c.114]

Справочное руководство в каждом случае представляет собой процедуры выполнения работы, зафиксированные на бумаге. В последние годы напечатано много книг и статей, посвященных как опробованным на практике, так и новым системам и процедурам, вопросам их внедрения и использования. Специалистам по программному обеспечению хорошо известна книга Брэндона, описывающая стандарты управления в обработке данных [65], Брэндон отделяет методические стандарты (общепринятую практику и способы выполнения работы) от рабочих стандартов. В данной книге рассмотрены только методические стандарты, которые в свою очередь подразделяются на методы управления и методы программирования. Кроме того, что методы программирования (стандартные соглашения по кодированию программ, полезные практические приемы и примеры плохо написанных программ, которым не следует подражать, форматы входных и выходных данных, протоколы сообщений и системы стандартных характеристик) очень нужны, в данной книге о них ничего не говорится. Эта книга в основном посвящена методам управления и организации работы как должны быть оформлены документы и что они должны содержать, как обеспечить обратную связь, как осуществлять конфигурационное управление изделием Путь внедрения методов управления — написание процедур, регламентирующих методику работы. [c.329]

Справочное руководство и справочный буклет должны быть готовы в окончательном виде в большом количестве (можно ксерокопии) на этапе Д21 (разд. 7). Это требуется фирме AB Servi es для проведения обучения. [c.373]

ОБУЧАЮ1ЩЯ ПРОГРАММА. В течение этой, таксказать, официальной части обучения новички получают (или обновляют) основные знания и вырабатывают навыки, необходимые в их работе. Например, продавцы изучают политику компании, правила работы на кассовом терминале и простейшие правила продажи товаров те, кто будет работать на складе, учатся правильно принимать и оформлять товар. Программа обучения может включать лекции, аудио- и видеокурсы. Новые работники получают справочные руководства и изучают правила веде- [c.306]

Источник

2.4.3. Информационно-справочные документы

Процесс принятия управленческих решений основан на сборе и обработке объективной и достоверной информации о фактическом состоянии дел в системе управления.

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

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

Особенностью этих документов является то, что они идут снизу вверх по системе управления, от работника к руководителю, от нижестоящей организации к вышестоящей.

К информационно-справочным документам относятся:

1) протоколы;

2) докладные записки;

3) предложения;

4) объяснительные записки;

5) заявления;

6) представления;

7) письма;

акты;

9) справки;

10) сводки;

11) заключения;

12) отзывы;

13) списки;

14) перечни;

15) телеграммы;

16) факсы;

17) электронные сообщения и другие справочные документы.

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

Виды деловой переписки и ее названия определяются способами передачи деловой информации, которые в настоящее время подразделяются на почтовую связь и электронную.

Протокол — это документ, фиксирующий ход заседания и порядок принятия решения коллегиальным органом управления. По степени фиксирования информации и степени полноты записи текста протоколы подразделяются на краткие и полные. Краткий протокол фиксирует фамилии докладчиков, темы докладов и выступлений и принятые решения. Полный протокол содержит запись всех выступлений по ходу заседания. Решение о том, какую форму протокола вести на заседании принимает руководитель коллегиального органа управления или руководитель организации.

От протоколов заседания коллегиальных органов управления следует отличать протоколы следственных, административных и других органов, а также протоколы договорного типа.

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

Ответственность за оформление и правильность записей в протоколе несет секретарь коллегиального органа управления или секретарь руководителя.

Протокол оформляется на общем бланке организации с указанием вида документа– «ПРОТОКОЛ». Обязательными реквизитами протокола являются: наименование организации; название вида документа; дата и номер документа, заголовок к тексту, текст; подпись председателя и секретаря заседания коллегиального органа управления.

В заголовке к протоколу указывается название коллегиального органа управления или его заседания.

Текст протокола состоит из двух частей: вводной и основной.

Вводная часть оформляется однообразно как при полной, так и сокращенной форме протокола. В ней указываются фамилии председателя и секретаря заседания коллегиального органа управления, фамилии или общее количество заседания и приглашенных лиц, повестка дня. Фамилии присутствующих и приглашенных, если их менее 15, записываются в алфавитном порядке, с указанием места работы и должности, а ели их больше 15, то оформляется список присутствующих и приглашены, который прикладывается к протоколу. В этом случае в протоколе делается запись: «Присутствовало … человек, список участников прилагается.».

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

Основная часть текста протокола строится по схеме: СЛУШАЛИ…ВЫСТУПИЛИ…ПОСТАНОВИЛИ (РЕШИЛИ).

В разделе «СЛУШАЛИ» в кратком протоколе указывается фамилия выступающего и тема его выступления. В полной форме протокола приводятся фамилии и инициалы докладчика, содержание его доклада или сообщения. Если текст доклада прилагается к протоколу в письменном виде, то допускается после темы доклада в скобках делать отметку «Текст доклада прилагается» и содержание доклада в протоколе не приводится.

В разделе «ВЫСТУПИЛИ» в кратких протоколах указываются только фамилии лиц, выступивших в обсуждении, а в полных – приводится содержание их выступления, включая заданные выступающему вопросы и его ответы.

В разделе «ПОСТАНОВИЛИ (РЕШИЛИ)» записывается принятое решение, которое формулируется кратко, точно, лаконично, во избежания двоякого толкования.

По каждому пункту решения указываются результаты голосования.

Каждый участник заседания коллегиального орган управления может предоставлять особое мнение по принятому решению, которое оформляется на отдельном листе и прилагается к протоколу. О наличии особого мнения делается запись в протоколе после решения.

Протокол подписывают председатель и секретарь, датой протокола является дата заседания (а если заседание продолжалось несколько дней, то через тире указывается дата начала и окончания заседания).

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

Образец оформления протокола приведен в приложении 24, 25.

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

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

Внешние справки оформляются на общем бланке организации, а внутренние – на стандартном листе бумаги.

Заголовок к тексту справки должен отвечать на вопрос «О чем?» и включать указание на период времени, к которому относятся указанные в справке сведения.

Текст справки, как правило, состоит из двух частей. В первой части излагаются факты, послужившие основанием или поводом для ее составления. Вторая часть приводит или описывает конкретные сведения, отражающие существо вопроса.

Если в справку включаются сведения по нескольким вопросам, то ее текст может состоять из разделов и подразделов.

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

Докладная записка – документ, адресованный руководителю данной или вышестоящей организации и информирующий его о сложившейся ситуации, имевшем место явлении или факте, о выполненной работе, а также содержащий выводы и предложения составителя. Докладная записка готовится как по инициативе самого работника, так и по указанию руководства. Цель докладной записки – побудить руководителя принять определенное решение.

Докладные записки бывают внешними и внутренними.

Внешняя докладная записка предоставляется руководству вышестоящих организаций, и оформляется на общем бланке организации. Внутренние докладные записки оформляются на стандартном листе бумаги.

Обязательными реквизитами докладной записки являются: наименование организации (структурного подразделения), наименование вида документа, дата и номер документа, адресат, заголовок к тексту, текст, подпись.

Внутреннюю докладную записку подписывает ее автор, а внешнюю – руководитель организации или его заместители. Датой докладной записки является дата ее составления или подписания.

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

Образец оформления докладной записки приведен в приложении 26, 27.

Объяснительная записка – это документ, поясняющий содержание отдельных положений основного документа или объясняющий причины какого – либо события, факта, поступка, составляемый работником организации и представляемый вышестоящему должностному лицу.

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

Объяснительную записку подписывает ее автор. Датой объяснительной записки является дата ее составления или подписания.

Образец оформления объяснительной записки приведен в приложении 28, 29.

Акт – документ, составленный несколькими лицами и подтверждающий установленный факт, событие, действие.

Существует множество разновидностей актов с точки зрения их содержания и назначения.

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

Главное при составлении акта – установление фактического состояния дел и правильное их отражение. Акт составляют на основе черновых записей, которые ведутся во время работы комиссии или группы лиц и содержат фактические данные, количественные показатели и другие сведения.

Акт оформляют на общем бланке организации. Обязательными реквизитами акта являются: название организации; название вида документа; дата и регистрационный номер документа; место составления; заголовок к тексту; текст; подписи и в случае необходимости – гриф утверждения.

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

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

В конце текста акта указывается количество составленных экземпляров и место их нахождения. Если акт имеет приложения, то отметка о них оформляется после отметки о количестве экземпляров.

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

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

Образец оформления акта приведен в приложении 30.

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

Телеграмма составляется в случаях, когда отправка документов почтой не обеспечивает своевременного решения вопросов.

Телеграмма оформляется на одной стороне телеграфного бланка и содержит следующие реквизиты: служебный заголовок; указание категории телеграммы; отметку о виде телеграммы; телеграфный адрес получателя; текст; подпись; регистрационный делопроизводственный номер; дату регистрации; адрес и наименование отправителя.

Текст телеграммы излагается кратко, без союзов и предлогов, с сокращенными обозначениями знаков препинания. Все цифровые обозначения в телеграмме пишутся словами.

В телеграммах не используют сложные, многословные предложения, характерные для деловых писем. Текст телеграммы должен содержать только конкретную информацию, отражающую существо ситуации.

Электронное сообщение – это документ, переданный электронной почтой по системе связи между ЭВМ, получаемый в виде видеограммы на экране монитора или в виде бумажной копии, отпечатанной на принтере.

Деловая переписка– обобщенное название различных по содержанию документов, выступающих в качестве инструмента оперативного информационного обмена между организациями. Основным документом оперативного информационного обмена является деловое письмо.

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

При ведении деловой переписки должны соблюдаться следующие требования:

1) документы оформляются на специальных бланках– бланках письма и подписываются руководителем организации или его заместителями в рамках предоставленной им компетенции;

2) текст письма должен составляться грамотно, аккуратно, без помарок и исправлений, официально – деловым стилем и не допускать неоднозначного толкования;

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

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

Во вступлении дается обоснование вопроса: причина возникновения вопроса или его краткая история. Если поводом для составления письма послужил какой-либо документ, то дается ссылка на него.

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

В заключительной части кратко формулируется основная цель письма.

Деловое письмо выполняет ту же функцию, что и человеческая речь. Речь может предшествовать предпринимаемым действиям или следовать за уже предпринятыми действиями. Точно так же все деловые письма можно разделить на констатирующие свершившийся факт и претворяющие возможность его свершения.

Поэтому очень часто письма напоминают монолог. К таким письмам относят письма-подтверждения, письма-напоминания, письма-извещения. Эти письма не требуют ответа, но сам факт их наличия имеет юридическое значение.

Существуют письма, которые сопровождают материальные ценности или другие документы. Их называют сопроводительными письмами. Сопроводительные письма фиксируют факт отправки документов или материальных ценностей, прикладываются к ним и несут дополнительную поясняющую информацию.

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

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

По функциональному признаку деловые письма делят на письма, требующие письма-ответа и письма, не требующие письма-ответа.

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

Ко второй группе писем относят: письма-предупреждения; письма-напоминания; письма-приглашения; письма-подтверждения; письма-отказы; сопроводительные письма; письма-извещения; гарантийные письма; информационные письма, письма-распоряжения.

Деловые письма всегда оформляются на бланке письма используя следующие реквизиты:

1) Государственный герб Российской Федерации;

2) герб субъекта РФ;

3) эмблема организации или товарный знак (знак обслуживания);

4) код организации;

5) основной государственный регистрационный номер (ОГРН) юридического лица;

6) идентификационный номер налогоплательщика/код причины постановки на учет (ИНН/КПП);

7) код формы документа;

наименование организации;

9) справочные данные об организации;

10) дата документа;

11) регистрационный номер документа;

12) ссылка на регистрационный номер и дату документа;

13) место составления или издания документа;

14) адресат;

15) заголовок к тексту;

16) текст документа;

17) подпись;

18) отметка об исполнителе;

19) идентификатор электронной копии документа.

Образец оформления письма приведен в приложении 31, 32.

Данный текст является ознакомительным фрагментом.

Предложения с «справочное руководство»

З. Справочное руководство ЕЦБ по отнесению к секторам состоит из двух отдельных частей.

Из своего первого 203-страничного издания КМОП превратился во всеобъемлющее справочное руководство по стилю на 1146 страницах в своем семнадцатом издании.

Официальное справочное руководство для Lua — Ierusalimschy, de Figueiredo & Celes 2006.

Я посмотрю на справочное руководство и внесу коррективы.

В настоящее время ограниченная публичная информация доступна для Cortex-M35P до тех пор, пока не будет выпущено его техническое справочное руководство.

В 1990 году было опубликовано Аннотированное справочное руководство по C++.

Почему мы говорим о дальнейших разделах чтения и альтернативных методах, когда это справочное руководство для начинающих?

Например, приведенное выше справочное руководство.

Другие результаты

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

PDF-версии руководств и другие справочные материалы для этих игр можно загрузить по следующим ссылкам.

На межучрежденческие справочные группы возлагались надежды в плане руководства процессом установления партнерских связей на страновом уровне.

Президиум приветствовал эту деятельность, а также перевод Справочного руководства ЕМЕП по отбору проб и химическому анализу на русский язык.

Учебные материалы, такие, как справочные руководства, могут распространяться в виде печатных изданий, на компакт-дисках или через Интернет.

На этих рабочих совещаниях были представлены и обсуждены два справочных руководства по расчету критических нагрузок тяжелых металлов для экосистем суши и водных экосистем.

Он обновит раздел Справочного руководства, посвященный вопросам оценки качества (ОК)/контроля качества (КК), и расширит информацию об ОК, имеющуюся в Интернете;

Вывод Uni / Duo Disk D-19 взят из справочного руководства Apple //c, Том 1.

ПЕРЕСТАНУТ ЛИ ЛЮДИ ИСПОЛЬЗОВАТЬ РУКОВОДСТВА ПО КОМПЬЮТЕРНЫМ ИГРАМ В КАЧЕСТВЕ СПРАВОЧНОГО МАТЕРИАЛА!

Документы кода часто организованы в стиле справочного руководства, что позволяет программисту быстро искать произвольную функцию или класс.

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

Президиум расширенного состава решил не рассматривать методы, которые уже описаны в различных технических справочных руководствах программ.

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

В Справочном руководстве ЕМЕП по отбору проб и химическому анализу указываются критерии, которые должны соблюдаться при выборе инструментария и методов аналитической работы.

В руководстве по персоналу и проекте справочника по управлению полевыми операциями излагается соответствующая политика в области персонала.

Дополнительные справочные материалы см. В примечательных статьях в руководстве по стилю и словаре § основные словари английского языка.

В 1946 году в справочном руководстве для конструкторов радиотехнического оборудования были перечислены следующие ныне устаревшие частоты, используемые в настоящее время.

Я продал ему Одиссею, справочник по Одиссее и руководство по справочнику по Одиссее.

Это руководство устанавливает стандарты для оказания помощи лицам, пережившим насилие, и служит справочным пособием для медицинских работников, полиции, юристов и сотрудников системы социального обеспечения.

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

Есть и руководство по произношению, или … (Электроный голос): справочник по произношению.

К 1989 году фаса опубликовала две работы, относящиеся к эпохе ПНП: руководство для офицеров следующего поколения в 1988 году и справочник первого года следующего поколения в 1989 году.

Источник

В данной статье речь пойдёт о страницах Справочного руководства (reference manual).

В прошлой записи было продемонстрировано, каким образом можно получить краткую справку об использовании команды при помощи ключа --help. Но если нужно более полно ознакомиться с тем, что делает команда, подробнее узнать о её опциях и аргументах, то следует обратиться к страницам Справочного руководства (manual pages или man pages).

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

Справочное руководство состоит из нескольких разделов или секций (sections). Традиционно разделы обозначаются цифрами от 1 до 9. Каждый раздел содержит страницы руководства определённого этим разделом типа. Например, в ОС FreeBSD и GNU/Linux разделы определены так:

Раздел 1 описывает пользовательские команды, такие как echo, uname и пр.
Раздел 2 содержит информацию о системных вызовах.
Раздел 3 предоставляет описание библиотечных функций.
Раздел 4 определяет назначение различных системных устройств, драйверов, протоколов.
Раздел 5 описывает различные форматы системных файлов и файлов конфигурации.
Раздел 6 рассказывает о играх и прочих развлечениях, присутствующих в системе.
Раздел 7 включает в себя различную интересную и полезную информацию.
Раздел 8 описывает системные утилиты, по большей части предназначенные для системного администрирования.
Раздел 9 предоставляет описание системных интерфейсов и интересен в первую очередь разработчикам ядра ОС.

В других операционных системах (например, в Solaris или HP-UX), существуют некоторые отличия от нумерации, приведённой выше. В частности, утилиты системного администрирования описываются в разделе 1M, вместо раздела 8, форматы файлов — в разделе 4, раздел 5 содержит различную информацию, а раздел 7 — информацию о файлах устройств.

В документации принято ссылаться на страницы Справочного руководства вместе с указанием раздела, которому страница принадлежит. Раздел записывается сразу вслед за названием страницы в круглых скобках, например, echo(1) означает страницу руководства с описанием пользовательской команды echo в разделе 1.

Для просмотра страниц руководства предназначена команда man. В качестве аргумента ей передаётся имя команды, функции или другой интересующей страницы. Например, чтобы просмотреть информацию о самой команде man, в командной строке следует ввести:

$ man man

Если система нашла запрошенную страницу, то последняя будет выведена на экран с возможностью постраничного просмотра. Если же указанная страница руководства не найдена, то оператор получит соответствующее сообщение:

$ man some_entry
No manual entry for some_entry

Страница Справочного руководства состоит из нескольких разделов, имеющих заголовки. В большинстве случаев эти разделы следующие:

NAME — содержит название страницы (команды, функции и т.д.) и краткое описание её предназначения.
SYNOPSIS — показывает синтаксис команды или функции, варианты использования.
DESCRIPTION — подробное описание предназначения и поведения команды, функции и т.д.
OPTIONS — перечисление ключей команды, параметров функций и пр. с их подробным описанием.
EXIT STATUS или RETURN VALUES — содержит варианты возвращаемых командой или функцией значений.
EXAMPLES — демонстрирует примеры использования описываемой команды или функции.
ENVIRONMENT — предоставляет информацию о задействованных переменных окружения.
FILES — перечисляет имена файлов, упомянутых на странице либо имеющих отношение к теме.
SEE ALSO — содержит ссылки на связанные страницы руководства, документацию или иные источники информации.

Естественно, некоторые из перечисленных разделов на странице могут отсутствовать, если они неприменимы, и, наоборот, могут присутствовать другие, например, раздел BUGS, описывающий известные ошибки и способы их обхода.

Для поиска страниц руководства существует две команды: apropos и whatis. Их синтаксис прост:

apropos keyword...
whatis name...

Эти команды выводят названия и краткое описание найденных страниц Справочного руководства, соответствующих запросу. Обе команды осуществляют поиск по базе данных ключевых слов (при условии, что она была сгенерирована либо вручную системным администратором, либо при помощи периодически исполняемых административных системных скриптов; в противном случае будет выведено сообщение об ошибке). Отличие состоит в том, что команда apropos ищет по заданному аргументу keyword как по подстроке в названии и кратком описании страниц руководства, а команда whatis — по полному названию страниц. Например:

$ apropos editor
ed(1), red(1)            - text editor
ee(1)                    - easy editor
ex(1), vi(1), view(1)    - text editors
sed(1)                   - stream editor
$ whatis intro
intro(1)                 - introduction to general commands (tools and utilities)
intro(2)                 - introduction to system calls and error numbers
intro(3)                 - introduction to the C libraries
intro(4)                 - introduction to devices and device drivers
intro(5)                 - introduction to file formats
intro(6)                 - introduction to games
intro(7)                 - miscellaneous information pages
intro(8)                 - introduction to system maintenance procedures and commands
intro(9)                 - introduction to system kernel interfaces

Теперь, чтобы просмотреть страницу руководства, скажем, для потокового редактора sed можно ввести команду:

$ man sed

Если страниц с одинаковым названием несколько (как в примере с whatis intro), то если просто ввести

$ man intro

то на экран будет выведена только одна из них. Какая именно — зависит от заложенного в утилиту man алгоритма порядка поиска страниц руководства по разделам. Если же мы хотим ознакомиться с введением в игры (страница intro(6)), то следует явно указать это команде man, задав номер раздела непосредственно перед названием страницы:

$ man 6 intro

В некоторых операционных системах (например, Solaris) номер раздела передаётся команде man в виде ключа. Для того, чтобы в этом убедиться, стоит заглянуть в страницу руководства по самой утилите man(1).

Команды apropos и whatis присутствуют не во всех системах (например, их нет в HP-UX). Их функции выполняет сама утилита man с соответствующими ключами: man -k является синонимом команды apropos, а man -f — команды whatis. Впрочем, в других системах это правило также действительно.

Ссылки по теме:

FreeBSD Man Pages — web-интерфейс к страницам руководства ОС FreeBSD.
Debian Hypertext Man Pages — web-интерфейс к страницам руководства ОС Debian GNU/Linux.
Solaris 10 Reference Manual Collection — страницы Справочного руководства ОС Solaris 10.
HP-UX Reference — страницы Справочного руководства ОС HP-UX 11i Version 3.

Источник

ГБ. СПЕЦИАЛЬНЫЕ СПРАВОЧНЫЕ РУКОВОДСТВА [c.526]

Общая математическая модель поверхностного конденсатора должна быть дополнена зависимостями физико-химических параметров, входящих в критериальные уравнения, от соответствующей температуры. Для конденсируемых продуктов специальной химии информация об этих зависимостях, содержащаяся в справочных руководствах и регламентных данных, оказывается далеко не полной. Поэтому в данном случае недостающая информация может быть восполнена расчетами по апробированным структурным формулам и методикам. [c.77]

Помимо этих руководств по общей лабораторной технике органической химии, следует указать на некоторые книги специального назначения. Например, существует огромное число рекомендаций в области выделения и очистки веществ с помощью перегонки. В общих руководствах вопросы перегонки разбираются без подробного изложения необходимых деталей. В каждом конкретном случае перегонки необходимо ознакомиться с приемами и приборами, уже ранее использованными в таких или аналогичных случаях. Очевидно, что при этом надо прибегнуть к помощи специальных справочных руководств в этой области. Такими справочниками могут служить [c.168]

Многие необходимые аналитикам сведения можно найти в описанной нами ранее справочной литературе по другим разделам химии. Однако имеется немало специальных справочных руководств. [c.222]

Аналитические методы обнаружения, определения и микроопределения сурьмы в сурьмяноорганических соединениях детально рассмотрены в соответствующих разделах специальных справочных руководств [1—3]. Там же приведены общие аналитические приемы работы с чувствительными к кислороду воздуха и влаге веществами, что существенно для исследования многих типов сурьмяноорганических производных. [c.377]

Развитие химической промышленности — одно из важнейших условий технического прогресса. Нет ни одной отрасли народного хозяйства, не связанной с применением химии. Поэтому столь большое внимание уделяется химическому образованию студентов в вузах. Однако краткие курсы химии для студентов нехимических специальностей требуют от них активизации самостоятельной работы. Включение самостоятельной работы в учебные планы является принципиально новым этапом в организации учебного процесса в высшей школе и предполагает умение студента организовать свою деятельность. Практическую помощь в этом могут оказать студенту учебные пособия, учитывающие профиль подготовки специалистов, справочники, справочные руководства. [c.3]

Справочное руководство адресовано ученым и преподавателям высшей школы, незаменимо для лекторов, читающих основные и специальные курсы органической химии в университетах, химико-технологических и фармацевтических институтах, для работников промышленности и научно-исследовательских институтов, для биохимиков и биологов. [c.909]

По замыслу автора книга должна служить главным образом справочным руководством общего характера. ЭПР-спектрометры используются в настоящее время настолько широко, что многие факультеты университетов заинтересованы в том, чтобы ввести в свои программы вводный курс по ЭПР-спектроскопии. (На тех же факультетах, которые ведут широкие исследования методами ЭПР-спектроскопии, будет очень полезен специальный двухгодичный курс по технике ЭПР-спектроскопии.) [c.10]

В связи с значительным развитием аналитической химии после рассмотрения общих справочных руководств и монографий по аналитической химии мы приведем специальную литературу по неорганическому анализу, органическому анализу и физикохимическим методам исследования, приобретающим все большее значение в практике аналитической химии. Выделен специальный раздел литературы по методам расчета результатов анализа. [c.226]

В процессе получения различных катализаторов, используемых при синтезе мономеров, а также при получении эмульсионных каучуков расходуется большое количество воды. Непосредственное применение речных, грунтовых (артезианских) и других природных БОД в указанных производствах недопустимо вследствие большого содержания в них минеральных солей и растворенных газов. Паровой конденсат в большинстве случаев также не может быть применен, потому что он дорог и содержит следы ржавчины, углекислого газа, а иногда и летучие ингибиторы коррозии, например октадециламин, который используют на современных ТЭЦ. Попадание ржавчины, а также посторонних солей в катализаторы может сделать их неактивными, а присутствие тех же загрязнений в латексе неизбежно скажется на его стабильности и на качестве каучука. При использовании воды, содержащей повышенное количество кислорода и двуокиси углерода, резко нарушается нормальный процесс эмульсионной полимеризации. Поэтому на отечественных заводах СК имеются специальные цехи водоочистки, обеспечивающие выпуск воды требуемого качества. Описание способов и техники водоподготовки в зависимости от происхождения воды и предъявляемых к ней требований приведены в томе 3 настоящего справочного руководства [I]. [c.133]

Книга предназначена для углубленного изучения органической химии и может служить справочным руководством для химико-органиков всех специальностей. [c.2]

Таблицы-схемы предназначены для химиков всех специальностей как краткий справочник по общей и неорганической химии. Кроме того, они являются справочным руководством для студентов, преподавателей и аспирантов вузов и университетов. [c.352]

Книгу можно рекомендовать в качестве основного справочного руководства для инженеров и исследователей анилинокрасочной и лакокрасочной промышленности, преподавателей вузов, а также как учебное пособие для аспирантов и студентов старших курсов химических специальностей. [c.12]

Для приближенного определения pH с точностью до единицы можно пользоваться универсальными индикаторами, представляющими собой смесь нескольких, чаще всего пяти-шести индикаторов с разными интервалами перехода. Точная рецептура изготовления таких индикаторов приводится в специальных руководствах и в справочной химической литературе. Там же указываются интервалы перехода смешанных индикаторов и соответствующее им окрашивание. Для некоторых универсальных индикаторов число таких переходов, а следовательно, и различных окрасок достигает двенадцати, практически охватывая всю шкалу pH. [c.36]

Практикум предназначается в качестве учебного пособия для студентов химико-технологических вузов. Он может быть использован студентами техникумов соответствуюш ей специальности, а также как справочное руководство для работников заводских лабораторий и научных учреждений, работающих в области полимеров. [c.4]

Номенклатура шахтных вентиляторов и вентиляторов тоннельной вентиляции довольно обширна и приведена в специальных справочных руководствах. Отличительной особенностью этих вентиляторов (по сравнению с вентиляторами общего назначения) является высокая подача. Например, вентилятор типа ВОМД-24 (осевой двухступенчатый реверсивный с диаметром рабочих колес 2400 мм), применяемый для реверсивной вентиляции метрополитена, имеет подачу при прямом ходе — 70 000—250 000 м /ч, при реверсивном — [c.184]

Значение k можно найти в некоторых справочных руководствах. В большинстве же случаев для определения k необходимо проведение специальных экспериментов. [c.57]

Справочное руководство предназначено для работников заводских лабораторий и научно-исследовательских институтов, изучающих структуру и свойства материалов, а также студентов соответствующих специальностей. [c.2]

Справочное руководство предназначено для исследователей различных специальностей, применяющих рентгеноструктурный анализ, в том числе для физиков, химиков, инженеров и т. д., и может быть полезно студентам университетов и технических вузов при изучении курсов рентгеноструктурного анализа и физических методов исследования. [c.328]

Поэтому нам кажется своевременным издание руководства, авторы которого — исследователи, конструкторы и теоретики в данной области — обобщили бы свой многолетний опыт работы по специальным разделам теории и применения газовой хроматографии. Таким образом, предлагаемая читателю книга имеет характер введения в предмет и в то же время является справочным пособием. [c.7]

Для функций Ф(ж), ip x) и величины Up составлены достаточно подробные таблицы, которь е приводятся во многих руководствах по теории вероятностей и математической статистике, а также в ряде специальных изданий справочного характера [6, 19, 26]. [c.13]

Книга отличается от справочных, учебных и других пособий тем, что должна являться в известной мере руководством к самостоятельным размышлениям и действиям техника и инженера, занимающихся использованием полимерных материалов в конкретных сооружениях, узлах и деталях. Именно в начальный период инженерной деятельности в новой области эта книга должна быть добрым советчиком. Ясно, что для такого инженера и техника в дальнейшем потребуется накопление сведений из специальной литературы, данных из [c.7]

При необходимости в справочных данных в области других ремонтно-сборочных работ следует руководствоваться специальной литературой [25. 2 . 27. 41. 52. 70, 7 ,72 , [c.742]

Книга предназначается в качестве практи-яеского руководства н справочного пособия для инженерно-технического персонала, занятого расчетами, конструированием, изготовлением, монтажом, ремонтом и эксплуатацией аппаратуры нефтеперерабатывающих заводов, а также заводов химической, нефтехимической, газовой и других отраслей промышленности, и может быть полезна студентам втузов и техникумов соответствующих специальностей. [c.2]

В отечественной справочной литературе проблемы коррозии и защиты от нее в промышленности пластмасс еще не освещались. Не были они отражены и в девятитомной серии справочных руководств Коррозия и защита химической аппаратуры , выпущенной издательством Химия в 1969—1974 гг. Это объяснялось отсутствием в то время достаточного объема необходимой информации. Сейчас положение изменилось в связи с созданием специальной противокоррозионной службы и появилась возможность собрать и обобщить как результаты лабораторных испытаний, так и данные, накопленные в ходе эксплуатации производств. [c.3]

Книга Страйера представляет собой оригинальное, очень удачно составленное руководство по общей динамической биохимии, которое можно горячо рекомендовать специализирующимся по биохимии студентам университетов, аспирантам, а также преподавателям, ведущим занятия по биохимии в различных высших и средних специальных учебных заведениях. В книге отлично изложены данные о динамике превращений биологически важных соединений и подробно разобраны ферментативные основы обмена веществ и энергии. Несмотря на обстоятельность изложения и сложность приводимых, вполне современных данных по биохимии и молекулярной биологии, материал излагается настолько просто и интересно и с такими замечательными иллюстрациями, что разобраться в нем не представляет сложности даже для относительно мало подготовленного читателя. Использовать книгу Страйера как справочное издание по биохимии невозможно в ней нет таблиц, характеризующих состав крови, мочи, органов и тканей, нет описания свойств и структуры различных биологически важных соединений, но зато строго последовательно разбирается и оценивается физиологическая значимость их превращений. Есть, как мне [c.5]

Являясь широким обобщением, книга Дж. Маллина Кристаллизация послужит хорошим справочным руководством для физико-химиков, химиков-технологов и металлургов, занятых получением кристаллов и монокристаллов особочистых веществ, и учебным пособием для аспирантов и студентов вузов химикометаллургических специальностей. [c.11]

Авторы книги Справочное руководство по эпоксидным смолам X. Ли и К. Невилл попытались рассмотреть в одной книге вопросы синтеза различных эпоксидных смол и их применение в самых разнообразных областях. Эпоксидные смолы находят все большее и большее применение, и появление книги X. Ли и К. Невилла для нашего читателя должно представлять большой интерес. Конечно, авторы взяли на себя весьма трудную задачу, попытавшись в одной книге описать применение эпоксидных смол и для зубоврачебного дела и в самолетостроении. Поэтому им не удалось описать применение этих смол с исчерпывающей полнотой для каждой отдельной области. Например, применение эпоксидных смол в электротехнике более обширно, чем описано в книге, и только одному этому вопросу в настоящее время может быть посвящена специальная книга. [c.3]

Теоретически и экспериментально доказано, что потенциал полуволны не зависит от концентрации данного вещества в растворе, характерен для каждого вещества и определяется его химической природой. Потенциалы полуволн для различных веществ (ионов) приведены в специальных руководствах (Виноградова Е. Н. и др., 1963] и Справочнике химика , (2-е изд. — М. — Л. Химия, 1965, т. IV). Следует, однако, учесть, что потенциал полуволны существенно зависит от фона (постороннего электролита), который применяется для повышенпя электропроводности раствора, поэтому в справочных таблицах приведены значения потенциала полуволны для вполне определенных условий. [c.60]

Исследования по выяснению структуры и функций белков требуют значительно более основательной методической подготовки биохимиков, специализирующихся в области хшшя белков и пептидов. В этом отношении может оказаться полезной предлагаемая читателю сравнительно небольшая книга английского исследователя Бэйли, в которой изложены основные современные методы, используемые при изучении химии белков. Книга предназначена для биохимиков широкого профиля, занимающихся исследованиями» структуры белков, но не имеющих специальной практической подготовки в области белковой химии. Достоинством книги является отбор и подробное описание в каждом методическом разделе только одного или нескольких апробированных вариантов данного метода. Ознакомление с материалом в значительной степени облегчают ссылки на важнейшие оригинальные работы, а также многочисленные-графики, таблицы и рисунки с изображением соответствующих приборов. Можно надеяться, что книга Бэйли послужит справочным методическим руководством для широкого круга биохимиков. [c.5]

Источник

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

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

Техническое
описание
системы.
Это
введение,
излагающее
основные
концепции
программного
изделия.
Оно
дает
будущему
пользователю
сведения
о
принципах
функционирования
и
возможностях
программного
изделия,
характеризует
программное
изделие
в
терминах
наиболее
общих
его
функций
и
освещает
самые
существенные
свойства.
Изложение
должно
быть
четким
и
касаться
наиболее
важных
характеристик
системы.
Это
описание
предназначено
для
лиц,
которые
могут
быть
не
знакомы
с
программированием
и
принципами
работы
ЭВМ,
но
которые
определяют
выбор
и
приобретение
средств
вычислительной
техники.
Основным
первоисточником
для
технического
описания
должно
быть
соглашение
о
требованиях,
дополненное
материалами
групп
разработки
и
поддержки.
Справочное
руководство.
В
нем
подробно
описаны
все
внешние
характеристики
программного
изделия.
Оно
обеспечивает
пользователю
набор
информации
о
назначении
программного
изделия,
о
необходимом
оборудовании
и
его
конфигурации,
о
языках
программирования,
включая
форматы
команд
и
сообщений,
о
структурах
входных
и
выходных
данных,
о
взаимосвязях
с
другими
программными
изделиями.
При
этом
предполагается,
что
читатель
справочного
руководства
имеет
опыт
работы
с
программами
и
техническими
средствами
ЭВМ.
Справочное
руководство
составляется
на
основе
внешних
спецификаций.
Дополнительный
материал
поставляет
группа
разработки.
Это
руководство
предназначено
для
программистов
и
системных
аналитиков,
которые
являются
непосредственными
пользователями
программного
изделия.
Справочный
буклет.
Он
обычно
имеет
карманный
формат
и
содержит
краткие
сведения
из
справочного
руководства.
Он
позволяет
быстро
ознакомиться
с
форматами
операторов,
мнемоникой
операций,
таблицами
преобразования
кодов,
синтаксисом
языка.
В
наиболее
сжатой
форме
этот
документ
называют
справочным
формуляром.
Руководство
оператора
содержит
информацию
для
пользователей,
которая
указывает,
как
эксплуатировать
программу
и
соответствующее
оборудование.
Оно
описывает
требуемые
характеристики
технических
средств,
управляющие
сообщения
и
рабочие
процедуры.
В
характеристиках
оборудования
излагаются
сведения
о
минимально
необходимой
конфигурации,
специальных
возможностях
оборудования
и
способах
закрепления
аппаратных
ресурсов
за
программами.
В
описании
управляющих
сообщений
даются
их
форматы
и
правила
использования,
а
также
конкретные
примеры.
В
рабочих
процедурах
описываются
все
последовательные
этапы
управления
системой,
включая
начальную
загрузку,
выполнение
заданий
и
восстановление
после
отказов.
Основным
источником
для
написания
руководства
оператора
служат
внешние
спецификации.
Дополнительная
информация
поступает
от
группы
разработки
и
группы
испытаний.
Руководство
предназначено
для
операторов,
которые
могут
и
не
иметь
большого
опыта
работы.
Указатель
системных
сообщений.
В
этом
документе
описываются
все
сообщения,
порождаемые
программой,
а
также
ситуации,
в
которых
они
возникают,
и
необходимые
действия
оператора.
Указатель
составляется,
в
основном,
по
листингам
программ
и
предназначен
для
операторов,
программистов
и
системных
аналитиков.

В
интерактивном
режиме
появляется
возможность
оперативно
выводить
справочную
информацию
на
экран.
В
таких
системах
выдается
большое
количество
сообщений
—
подсказок
и
сообщений
об
ошибках.
Группа
разработки
проектирует
лишь
программный
механизм
подобного
взаимодействия,
ответственность
за
окончательную
реализацию
текстов
сообщений,
их
стиль
и
форматы
несет
группа
выпуска
документации.
Она
приводит
и
проверяет
соответствие
печатных
материалов
сообщениям,
выдаваемым
в
режиме
on-line.

Кроме
соблюдения
стиля
документов,
группа
выпуска
документации
определят
поток
работ,
начиная
от
планирования
и
кончая
распространением
программного
изделия.
В
этой
инструкции
описываются
методы,
позволяющие
планировать
процесс
выпуска
документации
и
контролировать
выполнение
календарного
плана.

Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]

Источник

Необходимость в кратких справочных руководства

Преимущества чистой информации для изучения

Примеры краткого руководства

Eventful

Parse

Shopify

👨‍💻 Практическое занятие: краткое справочное руководство

Читайте также

Подбор экспертов и служб информационно-технической поддержки

Глава 8 Методика создания корпоративных информационно-управляющих систем

Информационно-аналитические системы

Основные справочные файлы

Приложение 1 Справочные материалы

Глава 4. ИНФОРМАЦИОННО-ПОИСКОВАЯ РАБОТА: ПРИВЛЕЧЕНИЕ К ДОВЕРИТЕЛЬНОМУ СОТРУДНИЧЕСТВУ ИНФОРМАТОРОВ СБ

Глава 5. ИНФОРМАЦИОННО-ПОИСКОВАЯ РАБОТА: ИСПОЛЬЗОВАНИЕ ВОЗМОЖНОСТЕЙ СТOPOHHИX ОРГАНИЗАЦИЙ

Глава 6. ИНФОРМАЦИОННО-ПОИСКОВАЯ РАБОТА: НАРУЖНОЕ НАБЛЮДЕНИЕ

Глава 7. ИНФОРМАЦИОННО-АНАЛИТИЧЕСКАЯ РАБОТА: ОСНОВНЫЕ ПРИНЦИПЫ

Глава 10. ИНФОРМАЦИОННО-АНАЛИТИЧЕСКАЯ РАБОТА: ОБРАБОТКА МАТЕРИАЛОВ СРЕДСТВ МАССОВОЙ ИНФОРМАЦИИ

Глава 11. «АКТИВНЫЕ МЕРОПРИЯТИЯ»: ИНФОРМАЦИОННО-ПСИХОЛОГИЧЕСКОЕ ВОЗДЕЙСТВИЕ

Глава 12. ИНФОРМАЦИОННО-АНАЛИТИЧЕСКАЯ РАБОТА: ДЕЗИНФОРМАЦИЯ

Справочные материалы

Справочные руководства по ролям в ТАМ

Создание справочной системы. Часть 2

Вопросы на естественном языке и Мастер Ответов

О загрузке Answer Wizard Builder

Описание Answer Wizard Builder

Предложения с «справочное руководство»