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

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

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

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

Технико-технологические
карты (ТТК) разрабатывают на новые и
фирменные блюда и кулинарные изделия
— те, которые вырабатывают и реализуют
только в данном предприятии. Срок
действия ТТК определяет само предприятие.
ТТК включает разделы:

1.
Наименование изделия и области применения
ТТК. Указывают точное название блюда,
которое нельзя изменить без утверждения;
приводят конкретный перечень предприятий
(филиалов), которым дано право производить
и реализовать данное блюдо.

2.
Перечень сырья для изготовления блюда
(изделия).

3.
Требования к качеству сырья. Обязательно
делают запись о том, что сырье, пищевые
продукты, полуфабрикаты для данного
блюда (изделия) соответствуют нормативным
документам (ГОСТам, ОСТам, ТУ) и имеют
сертификаты и удостоверения качества.

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

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

6.
Требования к оформлению, подаче,
реализации и хранению. Должны быть
отражены особенности оформления, правила
подачи блюда, порядка реализации,
хранения (в соответствии с ГОСТ
Р 50763-2007
«Услуги общественного питания. Продукция
общественного питания, реализуемая
населению. Общие технические условия»,
Санитарными правилами и Условиями
хранения особо скоропортящихся
продуктов).

7.
Показатели качества и безопасности.
Указывают органолептические показатели
блюда (вкус, запах, цвет, консистенция),
физико-химические и микробиологические
показатели, влияющие на безопасность
блюда.
8. Показатели пищевого состава
и энергетической ценности. Приводят
данные о пищевой и энергетической
ценности блюда (по таблицам «Химический
состав пищевых продуктов», одобренным
Минздравом), которые важны для организации
питания определенных групп потребителей
(диетическое, лечебно-профилактическое,
детское питание и др.).

Технологические
карты представлены в приложениях А, Б,
В, Г, Д.

Разработка нормативно-технической документации и ассортимента блюд для банкета, посвященного празднованию 9 мая на 40 человек

на тему: «Разработка нормативно-технической документации и ассортимента блюд для банкета, посвященного празднованию 9 мая на 40 человек»

Курс _________ Группа __________
Тема курсовой работы _____________________________________________________
________________________________________________________________________________________________________________________________________________
Студенту ________________________ предписывается выполнить следующий объем работы:
— Введение;

Преподаватель: ________________ (___________________)
Студент: ______________________(____________________)

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

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

Меню – это перечень блюд, кулинарных изделий и напитков на данный день. При составлении меню необходимо учитывать:

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

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

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

Наименование продуктов	Товароведная характеристика сырья
Икра	Это клетка, покрытая снаружи трехслойной оболочкой, под которой располагается пигментный слой, обуславливающий цвет икры. Это ценнейший продукт питания. Получают из яичников (ястыков) самок рыб, которые к периоду нереста достигают значительных размеров. В икре содержится от 50 до 60% воды, около 15% липидов и почти 25% белка.
Масло сливочное	Это концентрат молочного жира, полученный обработкой подготовленных сливок. Содержит: жира – 45-82,5, белка – 0,6-5,1, лактозы – 0,6-1,8, золы – 0,3-1,3, воды – 15,7-35, витамины А, Д, Е, группы В. Получают методом взбивания сливок.
Хлеб пшеничный	Хлеб – это продукт, выпеченный из теста, приготовленного из пшеничной муки. Он содержит витамины В1, В2, РР. Белки содержат все незаменимые аминокислоты. Крахмал в клейстеризованном виде, сахар растворен, жир эмульгирован. В хлебе содержатся минеральные вещества – фосфор, магний, калий. Повышают его пищевую ценность также добавление молока, яиц, солода, лактата кальция и тд.
Капуста белокочанная	Пищевая ценность капусты определяется содержанием сахаров 4-4,5, белков 1,8-2,8, минеральных веществ 1% (это калий, натрий, кальций, фосфор, магний, железо и тд.). В состав белков капусты входят сера, который обуславливает запах сероводорода при варке капусты. Капуста является источником витаминов – В1, В2, РР, С, Е.
Морковь	Корнеплод, в пищу используют утолщенный стержневой корень. Состоит из головки, шейки и корня. Содержит легкоусвояемые сахара, каротин в моркови в организме переходит в витамин А. А также, содержатся в нем – вода, белки, клетчатка, зола.
Лук зеленый	Выращивают из лука репчатого (севка). Содержит витамин С (до 30мг%) и каротин (4,8мг%). В пищу используют в свежем виде.
Перец сладкий	Относится к томатным овощам. Содержит: ;% сахара, 25мг% фосфора, витамина С от 150 до 250мг%.
Горошек консервированный	Представляет собой полуфабрикат для быстрого изготовления салатов. Горошек консервируют, заливая 2-3%-ным раствором поваренной соли.
Масло растительное	Это смесь триглицеридов высших жирных кислот. Содержит жира 99,9, воды 0,1%. Подсолнечное масло вырабатывают прессованием или экстракцией семян подсолнечника. Для меню данной курсовой работы используют рафинированное дезодорированное масло подсолнечное.
Огурцы свежие	Относится тыквенным овощам. Выращивают в открытом грунте, парниках и теплицах. Они содержат до 95% воды. В небольшом количестве они также содержат минеральные вещества (0,5%), азотистые вещества (0,8%), сахара (2,5%), витамины В1, В2, С, каротин. Пектиновые вещества огурцов обладают бактерицидными свойствами.
Помидоры свежие	Относится к томатным овощам. Высокая пищевая его ценность обусловлена наличием сахаров (4,2%), минеральных веществ (0,7%) и органических кислот (0,5%). Из минеральных веществ в состав помидоров входят соли калия, натрия, магния, фосфора, железа. А также витамины С, РР, каротин и группы В.
Уксус	Получают из этилового спирта путем уксуснокислого брожения или разведением уксусной эссенции водой. Выпускают 9%-ный.
Треска потрошенная обезглавленная	Содержит в своем составе воду, белки, жиры, минеральные вещества, углеводы, экстрактивные азотистые вещества, кальций, фосфор, калий, натрий, магний, витамины А, Д, Е, К, Н, РР, группы В. Поступает в предприятия потрошеным обезглавленным в мороженом виде.
Картофель	Клубнеплод, используют в пищу утолщенное окончание подземного стебля. Клубень покрыт корой, на поверхности которой образуется пробка – кожура. В пробке имеются отверстия – чечевички для газо и водообмена. В нем содержатся: воды – 70-80, крахмала – 12-25, сахара – 0,3-1,8, клетчатки – 0,2-1,3, азотистых веществ – 1,5-3, минеральных веществ – 0,5-2, жира – 0,1, витамины С (20мг%), В1, В2, В6, РР.
Сыр голландский	Высокопитательный пищевой продукт, вырабатываемый свертыванием молока с последующей обработкой сгустка. Химический состав: воды – 39,5, белков – 26,8, жиров – 27,3, органических кислот – 2,2, золы – 4,2%. А также в нем содержатся витамины А, В1, В2, РР, С.
Маргарин столовый	Это высокодисперсная жироводная эмульсия, содержащая высококачественные пищевые жиры, молоко, соль, сахар, эмульгаторы. Химический состав: воды – 15,6-17, белка – 0,3-1,2, жира – 62-83, углеводов – 0,5-1,2%.
Мука пшеничная	Порошкообразный продукт, полученный при размоле хлебных злаков. Пшеничная мука содержит: воды – 14-15, белков – 10,3-12,9, жиров – 0,9-1,8, крахмала – 55,8-67,7, клетчатки – 0,1-1,9, золы – 0,5-2, витамины В1, В2, РР. А также – фосфор, калий, магний, железо, натрий, марганец, медь.
Мясо говядины	Мясо – это туша или часть туши, полученная после убоя и первичной обработки скота и представляющая собой совокупность различных тканей – мышечной, соединительной, жировой, костной и тд. в состав мяса входит: вода – 52-78, белки – 16-21, жиры – 0,5-37, углеводы – 0,4-0,8, экстрактивные вещества – 2,5-3, минеральные вещества – 0,7-1,3, ферменты, витамины А, Д, РР, группы В. Говядину по упитанности делят на 1 и 2 категорию.
Окорок копчено-вареный	Это продукт из свинины варено-копченый. Окорок – это тазобедренная, лопаточная части, с костями или частично удаленными костями, форма прямоугольная, удлиненно-округлая.
Сосиски	Это изделия из мясного фарша в оболочке. Отличается от вареных колбас тем, что не содержат шпика.
Почки говяжьи	Это съедобный внутренний орган мяса говядины. Содержит много полноценных белков. Химический состав: вода – 82,7, белки – 12,5, жиры – 1,8, экстрактивные вещества – 1,9, зола – 1,1. а также содержит калий, железо, витамины В2, РР, Н. По пищевой ценности относится к 1 категории субпродуктов.
Лук репчатый	Состоит из донца, от которого отходят вниз корни, а вверх – мясистые чешуи. В луке содержится сахар – 9, белки – 3, минеральные вещества – 1,2% и витамины С, В1, В2. Эфирные масла и гликозиды придают луковым овощам острый вкус и аромат. В них содержатся также фитонциды, обладающие бактерицидными свойствами.
Огурцы соленые	Это короткоплодные огурцы с плотной мякотью с небольшой семенной камерой, засоленные в рассоле 6-9%-ной концентрации. Содержание соли в соленых огурцах должно составлять 2,5-3,5%, кислотность 0,6-1,2%. Масса огурцов должна быть не менее 55% общей массы с рассолом.
Томатное пюре	Получают увариванием протертой томатной массы из зрелых томатов в открытых чанах. Томат-пюре вырабатывают с содержанием сухих веществ 12,15 и 20%.
Шампиньоны свежие	Относятся к сапрофитам (питаются остатками мертвых растений – перегной, навоз). Содержит экстрактивные и ароматические вещества. В пищу используют плодовое тело (шляпку и ножку).
Сметана	Это продукт, вырабатываемый из пастеризованных сливок путем сквашивания закваской, приготовленной на чистых культурах молочнокислых стрептококков. Химический состав: воды – 54,2-82,7, белков – 2,4-2,8, жира – 10-40, углеводов – 2,6-3,2, минеральных веществ – 0,4-0,5, витамины А, Е, В1, В2, РР, С.
Чернослив	Это сушеный продукт из слив, который получают из различных сортов венгерок. Содержание влаги в различных сушеных плодах колеблется от 16 до 25%.
Чай в/сорт	Относится к вкусовым товарам. Химический состав: воды – 8,5, кофеина – 2-5, дубильных веществ – 11-30, белковых веществ – 20, клетчатки – 4,5, органических кислот – 1,2, минеральных веществ – 5,5, чайного эфирного масла – 0,014-0,007, витамины РР, Р, С, В1, В2, ферменты, красящие вещества. Черный байховый чай получают из сортового чайного листа путем завяливания, скручивания, ферментации, сушки, сортировки и упаковки. По качеству делят на 1, 2, 3, сорт, высший, букет и экстра сорт.
Сахар	Состоит из отдельных кристаллов сахарозы. Вырабатывают его из сахарной свеклы и сахара-сырца. Размер кристаллов от 0,2 до 2,5мм. Содержание сахарозы – не менее 99,75%, влаги – не более 0,14%.

Как создать техническую документацию за 6 простых шагов [+ примеры]

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

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

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

В этой статье мы говорим о технической документации. Вот что вы найдете ниже.

• Что такое техническая документация?
• Типы технической документации
• Как создать техническую документацию (6 простых шагов)
• Примеры технической документации
• Настройка ваших команд на успех

Начнем с основ.

Что такое техническая документация?

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

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

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

Теперь мы рассмотрим различные типы технической документации.

Типы технической документации

1. Требования к продукту
2. Дизайн взаимодействия с пользователем (UX)
3. Руководства для конечных пользователей
4. Планы проекта
5. Дорожные карты продуктов
6. Графики испытаний

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

Обычно они относятся к одной из двух категорий: документация по продукту и документация по процессу.

Далее мы рассмотрим несколько в каждой категории.

Документация по продукту

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

Требования к продукту

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

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

Документы с требованиями к продукту обычно включают:

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

Дизайн взаимодействия с пользователем (UX)

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

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

Документы по дизайну UX обычно включают:

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

Руководства конечного пользователя

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

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

Руководства для конечных пользователей обычно включают:

• Настройка продукта инструкции — чтобы пользователи могли начать работу после покупки
• Руководства по устранению неполадок — чтобы помочь пользователям самостоятельно решать проблемы
• Часто задаваемые вопросы — для ответов на общие вопросы, связанные с продуктом

Технологическая документация

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

Планы проекта

План проекта определяет цели, задачи, роли и обязанности, а также необходимые задачи для конкретного проекта.

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

Планы проекта обычно включают:

• Обзор проекта и цели — для определения цели и важности проекта
• Вехи проекта — для определения основных точек прогресса на этом пути
• Временная шкала проекта — для отслеживания шагов от начала проекта до его завершения

Дорожные карты продуктов

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

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

Дорожные карты продуктов обычно включают:

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

Графики тестирования

График тестирования аналогичен плану проекта, но относится к процессу тестирования программного обеспечения или продукта.

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

Графики тестирования обычно включают:

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

Как создать техническую документацию (6 простых шагов)

1. Определите свою аудиторию.
2. Определение типов документации.
3. Создавайте свои шаблоны.
4. Планирование и разработка контента.
5. Просмотрите и соберите отзывы.
6. Своевременно обновляйте документацию.

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

Рассмотрим каждый ниже.

1. Определите свою аудиторию.

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

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

2. Определите типы документации.

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

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

3. Создайте свои шаблоны.

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

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

4. Планирование и разработка контента.

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

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

5. Просмотрите и соберите отзывы.

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

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

6. Обновляйте документацию.

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

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

Примеры технической документации

1. Справочный центр HubSpot
2. Документация разработчика Apple
3. Инструкция по сборке ИКЕА

Вот несколько примеров технической документации.

Справочный центр HubSpot

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

Документация разработчика Apple

Источник изображения

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

Инструкции по сборке ИКЕА

Источник изображения

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

Подготовка вашей команды к успеху

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

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

В противном случае вы рискуете сжечь дом.

Темы:

База знаний

Не забудьте поделиться этим постом!

История технической документации | by Jacklyn

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

Некоторые из нас до сих пор помнят руководства пользователя, которые поставлялись с Windows 95 или установкой AOL, но какие технические документы были у нас до этого? Как далеко уходит практика технической документации?

Один из самых ранних примеров того, что мы можем назвать «компьютерной документацией», был обнаружен более 100 лет назад у побережья острова Антикифера (также называемого Антикитера). Дайверы нашли механизм, который позже назовут «первым компьютером» — Антикитерский механизм.

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

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

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

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

Первый официальный патент принадлежит Филиппо Брунеллески, который запатентовал конструкцию лодки. Патент, который теперь называется Il Badalone , был написан в 1421 году. true», но они определенно служат формой технического документа даже сегодня.

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

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

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

В 1800-х годах Чарльз Бэббидж создал разностную машину, одну из первых форм компьютера. Его документация и планы, показанные ниже, вдохновили математика Аду Лавлейс на продолжение работы Бэббиджа и создание аналитической машины.

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

Техническая документация сильно изменилась с течением времени из-за технологий.