Документация: Документация — это… Что такое Документация?

Документация: Документация — это… Что такое Документация?

Содержание

Документация - это... Что такое Документация?

Документа́ция — это совокупность данных и документов.

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

Документирование связано с делопроизводством (документационным обеспечением управления), отраслью деятельности, обеспечивающая документирование и организацию работы с официальными документами. (ГОСТ Р 51141-98. Делопроизводство и архивное дело. Термины и определения. Утв. постановлением Госстандарта РФ от 27 февраля 1998 г. N 28)

Виды документации

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

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

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

Техническую документацию разделяют на несколько видов:

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

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

Строительная документация

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

Документация на программное обеспечение

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

Аудиторская документация

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

И другие

Литература

  • Нечаева Е. В. Документоведение и документационное обеспечение управления. I ч. СПб.: Изд-во СПб ГПУ, 2003.
  • Журнал «Отечественные архивы» (Федеральная архивная служба РФ)

ДОКУМЕНТАЦИЯ - это... Что такое ДОКУМЕНТАЦИЯ?

  • ДОКУМЕНТАЦИЯ — 1) совокупность документов, посвященных какому либо вопросу (напр., документация тендерная), 2) способ первичного отражения (регистрация) хозяйственных операций в специальных документах учета, являющихся основанием для бухгалтерских записей. На… …   Юридический словарь

  • ДОКУМЕНТАЦИЯ — ДОКУМЕНТАЦИЯ, документации, мн. нет, жен. (книжн.). Действие по гл. документировать. Подробная документация. Толковый словарь Ушакова. Д.Н. Ушаков. 1935 1940 …   Толковый словарь Ушакова

  • документация — материал, данные, факты, документы Словарь русских синонимов. документация сущ., кол во синонимов: 2 • техдокументация (1) • …   Словарь синонимов

  • документация — и, ж. documentation f., нем. Documentation. 1. Обоснование, подтверждение чего л. документами. БАС 1. Целостность (интегритет) Османской империи подтвердилась не в парламентских речах и яркой публицистике, а в полной международной правовой… …   Исторический словарь галлицизмов русского языка

  • Документация — пакет официальных документов, составленных по определенной форме и содержащих конкретную информацию. Словарь бизнес терминов. Академик.ру. 2001 …   Словарь бизнес-терминов

  • ДОКУМЕНТАЦИЯ — ДОКУМЕНТАЦИЯ, и, жен. 1. см. документировать. 2. собир. Документы (в 1 знач.). Техническая д. | прил. документационный, ая, ое. Толковый словарь Ожегова. С.И. Ожегов, Н.Ю. Шведова. 1949 1992 …   Толковый словарь Ожегова

  • документация — и, мн. нет, ж. (нем. Dokumentation …   Словарь иностранных слов русского языка

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

  • ДОКУМЕНТАЦИЯ — совокупность официально признанных документов, составленных по определенной форме и содержащих предусмотренную информацию. Различают бухгалтерскую, техническую, проектную, конструкторскую, технологическую, товарную и т.д. Д …   Юридическая энциклопедия

  • документация — 4.11 документация (documentation): Печатные руководства пользователя, диалоговая (оперативная) документация и справочный текст («хелпы»), описывающие как пользоваться программным продуктом. Источник: ГОСТ Р ИСО/МЭК 15910 2002: Инф …   Словарь-справочник терминов нормативно-технической документации

  • Документация — Википедия. Что такое Документация

    Документа́ция — это совокупность данных и документов.

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

    Документирование связано с делопроизводством (документационным обеспечением управления), отраслью деятельности, обеспечивающей документирование и организацию работы с официальными документами. (ГОСТ Р 51141-98. Делопроизводство и архивное дело. Термины и определения. Утв. постановлением Госстандарта РФ от 27 февраля 1998 г. N 28)

    Виды документации

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

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

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

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

    Техническую документацию разделяют на несколько видов:

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

    Документация на программное обеспечение

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

    Аудиторская документация

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

    И другие

    Литература

    • Нечаева Е. В. Документоведение и документационное обеспечение управления. I ч. СПб.: Изд-во СПб ГПУ, 2003.
    • Журнал «Отечественные архивы» (Федеральная архивная служба РФ)

    документация - это... Что такое документация?

  • ДОКУМЕНТАЦИЯ — 1) совокупность документов, посвященных какому либо вопросу (напр., документация тендерная), 2) способ первичного отражения (регистрация) хозяйственных операций в специальных документах учета, являющихся основанием для бухгалтерских записей. На… …   Юридический словарь

  • ДОКУМЕНТАЦИЯ — ДОКУМЕНТАЦИЯ, документации, мн. нет, жен. (книжн.). Действие по гл. документировать. Подробная документация. Толковый словарь Ушакова. Д.Н. Ушаков. 1935 1940 …   Толковый словарь Ушакова

  • документация — материал, данные, факты, документы Словарь русских синонимов. документация сущ., кол во синонимов: 2 • техдокументация (1) • …   Словарь синонимов

  • документация — и, ж. documentation f., нем. Documentation. 1. Обоснование, подтверждение чего л. документами. БАС 1. Целостность (интегритет) Османской империи подтвердилась не в парламентских речах и яркой публицистике, а в полной международной правовой… …   Исторический словарь галлицизмов русского языка

  • Документация — пакет официальных документов, составленных по определенной форме и содержащих конкретную информацию. Словарь бизнес терминов. Академик.ру. 2001 …   Словарь бизнес-терминов

  • ДОКУМЕНТАЦИЯ — совокупность официально признанных документов, составленных по определенной форме и содержащих предусмотренную информацию. Различают бухгалтерскую, техническую, проектную, конструкторскую, технологическую, товарную (товаросопровождающую)… …   Экономический словарь

  • ДОКУМЕНТАЦИЯ — ДОКУМЕНТАЦИЯ, и, жен. 1. см. документировать. 2. собир. Документы (в 1 знач.). Техническая д. | прил. документационный, ая, ое. Толковый словарь Ожегова. С.И. Ожегов, Н.Ю. Шведова. 1949 1992 …   Толковый словарь Ожегова

  • документация — и, мн. нет, ж. (нем. Dokumentation …   Словарь иностранных слов русского языка

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

  • ДОКУМЕНТАЦИЯ — совокупность официально признанных документов, составленных по определенной форме и содержащих предусмотренную информацию. Различают бухгалтерскую, техническую, проектную, конструкторскую, технологическую, товарную и т.д. Д …   Юридическая энциклопедия

  • документация — 4.11 документация (documentation): Печатные руководства пользователя, диалоговая (оперативная) документация и справочный текст («хелпы»), описывающие как пользоваться программным продуктом. Источник: ГОСТ Р ИСО/МЭК 15910 2002: Инф …   Словарь-справочник терминов нормативно-технической документации

  • ДОКУМЕНТАЦИЯ - это... Что такое ДОКУМЕНТАЦИЯ?

  • ДОКУМЕНТАЦИЯ — 1) совокупность документов, посвященных какому либо вопросу (напр., документация тендерная), 2) способ первичного отражения (регистрация) хозяйственных операций в специальных документах учета, являющихся основанием для бухгалтерских записей. На… …   Юридический словарь

  • ДОКУМЕНТАЦИЯ — ДОКУМЕНТАЦИЯ, документации, мн. нет, жен. (книжн.). Действие по гл. документировать. Подробная документация. Толковый словарь Ушакова. Д.Н. Ушаков. 1935 1940 …   Толковый словарь Ушакова

  • документация — материал, данные, факты, документы Словарь русских синонимов. документация сущ., кол во синонимов: 2 • техдокументация (1) • …   Словарь синонимов

  • документация — и, ж. documentation f., нем. Documentation. 1. Обоснование, подтверждение чего л. документами. БАС 1. Целостность (интегритет) Османской империи подтвердилась не в парламентских речах и яркой публицистике, а в полной международной правовой… …   Исторический словарь галлицизмов русского языка

  • Документация — пакет официальных документов, составленных по определенной форме и содержащих конкретную информацию. Словарь бизнес терминов. Академик.ру. 2001 …   Словарь бизнес-терминов

  • ДОКУМЕНТАЦИЯ — совокупность официально признанных документов, составленных по определенной форме и содержащих предусмотренную информацию. Различают бухгалтерскую, техническую, проектную, конструкторскую, технологическую, товарную (товаросопровождающую)… …   Экономический словарь

  • документация — и, мн. нет, ж. (нем. Dokumentation …   Словарь иностранных слов русского языка

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

  • ДОКУМЕНТАЦИЯ — совокупность официально признанных документов, составленных по определенной форме и содержащих предусмотренную информацию. Различают бухгалтерскую, техническую, проектную, конструкторскую, технологическую, товарную и т.д. Д …   Юридическая энциклопедия

  • документация — 4.11 документация (documentation): Печатные руководства пользователя, диалоговая (оперативная) документация и справочный текст («хелпы»), описывающие как пользоваться программным продуктом. Источник: ГОСТ Р ИСО/МЭК 15910 2002: Инф …   Словарь-справочник терминов нормативно-технической документации

  • ДОКУМЕНТАЦИЯ - это... Что такое ДОКУМЕНТАЦИЯ?

  • ДОКУМЕНТАЦИЯ — 1) совокупность документов, посвященных какому либо вопросу (напр., документация тендерная), 2) способ первичного отражения (регистрация) хозяйственных операций в специальных документах учета, являющихся основанием для бухгалтерских записей. На… …   Юридический словарь

  • документация — материал, данные, факты, документы Словарь русских синонимов. документация сущ., кол во синонимов: 2 • техдокументация (1) • …   Словарь синонимов

  • документация — и, ж. documentation f., нем. Documentation. 1. Обоснование, подтверждение чего л. документами. БАС 1. Целостность (интегритет) Османской империи подтвердилась не в парламентских речах и яркой публицистике, а в полной международной правовой… …   Исторический словарь галлицизмов русского языка

  • Документация — пакет официальных документов, составленных по определенной форме и содержащих конкретную информацию. Словарь бизнес терминов. Академик.ру. 2001 …   Словарь бизнес-терминов

  • ДОКУМЕНТАЦИЯ — совокупность официально признанных документов, составленных по определенной форме и содержащих предусмотренную информацию. Различают бухгалтерскую, техническую, проектную, конструкторскую, технологическую, товарную (товаросопровождающую)… …   Экономический словарь

  • ДОКУМЕНТАЦИЯ — ДОКУМЕНТАЦИЯ, и, жен. 1. см. документировать. 2. собир. Документы (в 1 знач.). Техническая д. | прил. документационный, ая, ое. Толковый словарь Ожегова. С.И. Ожегов, Н.Ю. Шведова. 1949 1992 …   Толковый словарь Ожегова

  • документация — и, мн. нет, ж. (нем. Dokumentation …   Словарь иностранных слов русского языка

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

  • ДОКУМЕНТАЦИЯ — совокупность официально признанных документов, составленных по определенной форме и содержащих предусмотренную информацию. Различают бухгалтерскую, техническую, проектную, конструкторскую, технологическую, товарную и т.д. Д …   Юридическая энциклопедия

  • документация — 4.11 документация (documentation): Печатные руководства пользователя, диалоговая (оперативная) документация и справочный текст («хелпы»), описывающие как пользоваться программным продуктом. Источник: ГОСТ Р ИСО/МЭК 15910 2002: Инф …   Словарь-справочник терминов нормативно-технической документации

  • Документация - это... Что такое документация?

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

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

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

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

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

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

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

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

    Первую группу источников по истории русского масонства XVIII - первой четверти XIX веков составляет официальная правительственная документация:

    Другой важнейшей группой источников по истории масонства XVIII - начала XIX веков является официальная масонская документация.

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

    Время чтения: 18 минут

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

    Project documentation by stages and purpose

    Project documentation by stages and purpose Проектная документация по этапам и назначению

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

    Agile и водопад

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

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

    Agile Development Cycle

    Agile Development Cycle

    Схема цикла разработки Agile

    Гибкий подход основан на командной работе, тесном сотрудничестве с клиентами и заинтересованными сторонами, гибкости и способности быстро реагировать на изменения. Основные строительные блоки гибкой разработки - это итерации; каждый из них включает планирование, анализ, проектирование, разработку и тестирование.Вначале гибкий метод не требует исчерпывающей документации. Менеджерам не нужно много планировать заранее, потому что все может меняться по мере развития проекта. Это позволяет осуществлять планирование точно в срок. Согласно одной из ценностей Agile Manifesto, поставив «работающее программное обеспечение над исчерпывающей документацией», идея состоит в том, чтобы создавать документацию с информацией, которая необходима для продвижения вперед, когда это имеет наибольший смысл.

    Сегодня Agile является наиболее распространенной практикой в ​​разработке программного обеспечения, поэтому мы сосредоточимся на практике документации, связанной с этим методом.

    Виды документации

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

    В соответствии со следующими классификациями.

    Software documentation types

    Software documentation types

    Программная документация, наиболее часто используемая в Agile проектах

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

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

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

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

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

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

    Продукт: Системная документация

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

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

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

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

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

    Technical documentation example

    Technical documentation example

    Software documentation example

    Software documentation example

    Пример технической документации: документ с требованиями к программному обеспечению на одной веб-странице, созданный с использованием Atlassian Confluence , программного обеспечения для совместной работы с контентом

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

    1. Роли и обязанности .Начните свой документ с информации об участниках проекта, включая владельца продукта, членов команды и заинтересованных лиц. Эти детали прояснят обязанности и сообщат о целевых целях выпуска для каждого из членов команды.
    2. Цели команды и бизнес-задача . Кратко опишите наиболее важные цели.
    3. Предпосылки и стратегическое соответствие . Кратко объясните стратегическую цель ваших действий. Почему вы создаете продукт? Как ваши действия влияют на разработку продукта и соответствуют целям компании?
    4. Предположения. Создайте список технических или бизнес-предположений, которые могла бы иметь группа.
    5. Пользовательские истории. Перечислить или связать пользовательские истории, необходимые для проекта. Пользовательская история - это документ, написанный с точки зрения человека, использующего ваш программный продукт. История пользователя - это краткое описание действий клиентов и результатов, которых они хотят достичь.
    6. Критерии приемки. Это условия, которые указывают на завершение пользовательской истории. Основная цель критериев приемлемости - определить удовлетворительный результат для сценария использования с точки зрения конечного пользователя.Прочтите нашу специальную статью о критериях приема, чтобы узнать больше.
    7. Взаимодействие с пользователем и дизайн . Свяжите со страницей исследования дизайна и каркасы.
    8. Вопросы. По мере того, как команда решает проблемы по ходу проекта, у них неизбежно возникает много вопросов. Хорошая практика - записывать все эти вопросы и отслеживать их.
    9. Не работает. Составьте список того, что вы не делаете сейчас, но планируете сделать в ближайшее время. Такой список поможет вам организовать командную работу и расставить приоритеты.

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

    • Используйте ссылки и якоря . Они помогут вам упростить чтение и поиск документа, поскольку читатели смогут постепенно понимать информацию. Например, вы можете предоставить ссылки на интервью с клиентами и привязки к предыдущим обсуждениям или другую внешнюю информацию, связанную с проектом.
    • Используйте инструменты построения диаграмм , чтобы лучше сообщить о проблемах вашей команде.Люди более склонны воспринимать информацию, глядя на изображения, чем читая обширный документ. Различные визуальные модели помогут вам выполнить эту задачу и более эффективно обозначить требования. Вы можете включать диаграммы в процесс создания требований, используя следующие программные инструменты построения диаграмм: Visio, Gliffy, Balsamiq, Axure или SmartArt в Microsoft Office.

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

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

    Документацию UX можно разделить на этапы. Этап исследования включает:

    • Персоны пользователей
    • Пользовательский сценарий
    • Карта сценария
    • Карта истории пользователя
    • Руководство по стилю UX

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

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

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

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

    User story map example

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

    Источник: realtimeboard.com

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

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

    • Карты сайта
    • Каркасы
    • Мокапы
    • Прототипы
    • Схемы потоков пользователя или путь пользователя
    • Отчеты тестирования юзабилити

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

    Site map example

    Site map example

    Пример структуры карты сайта

    Источник: uxforthemasses.com

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

    User flow scheme example

    User flow scheme example

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

    Источник: medium.com

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

    Wireframe example

    Wireframe example

    Пример каркаса для мобильного приложения Peekaboo

    Источник: gallery.wacom.com

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

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

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

    Документ об архитектуре программного обеспечения

    Проектная документация архитектуры программного обеспечения

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

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

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

    Описание User Story. Свяжите истории пользователей со связанными бизнес-процессами и связанными сценариями. Вам следует избегать технических подробностей в этом разделе.

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

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

    Architecture diagram

    Architecture diagram

    Схема архитектуры веб-приложений Azure

    Источник: docs.microsoft.com

    Исходный код документа

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

    Документы с исходным кодом могут включать, но не ограничиваются, следующие сведения:

    • Фреймворк для генерации HTML и другие применяемые фреймворки
    • Тип привязки данных
    • Шаблон проектирования с примерами (например, модель-представление-контроллер)
    • Меры безопасности
    • Другие модели и принципы

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

    Документация по обеспечению качества

    В Agile есть разные типы тестовых документов. Мы выделили самые распространенные:

    • План управления качеством
    • Стратегия тестирования
    • План испытаний
    • Технические характеристики тестового набора
    • Контрольные листы испытаний

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

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

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

    • Список функций для тестирования
    • Методы испытаний
    • Таймфреймы
    • Роли и обязанности (например, модульные тесты могут выполняться командой QA или инженерами)

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

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

    Техническое обслуживание и справочное руководство

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

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

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

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

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

    Продукт: Пользовательская документация

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

    • конечных пользователей
    • системные администраторы

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

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

    • Часто задаваемые вопросы
    • Видеоуроки
    • Встроенная поддержка
    • Порталы поддержки

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Есть три типа дорожных карт продукта, которые используются производственными группами Agile:

    • Стратегическая дорожная карта
    • Дорожная карта технологий или ИТ
    • План выпуска

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

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

    Strategic software product roadmap example

    Strategic software product roadmap example

    Пример дорожной карты стратегического программного обеспечения

    Источник: productplan.com

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

    Technology roadmap example

    Technology roadmap example

    Пример технологической дорожной карты

    Источник: hutwork.com

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

    Release plan example

    Release plan example

    Пример плана выпуска

    Источник: productplan.com

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

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

    Инструмент общего назначения

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

    • Atlassian Confluence - самый популярный инструмент для совместных проектов, в котором есть вся экосистема для управления требованиями к продукту и написания документации.Confluence известен стабильной вики-системой и эффективным интерфейсом управления пользовательскими историями.
    • Document 360 - это база знаний самообслуживания / платформа документации по программному обеспечению, разработанная для продуктов «Программное обеспечение как услуга».
    • ai - это инструмент для совместного создания, хранения, обмена данными и использования вики-системы документации. Документация интерактивна, что означает, что разработчики могут встраивать блоки или фрагменты кода прямо в документ и делиться им одним щелчком мыши. Закончив редактирование документации, вы можете сохранить ее в формате PDF или markdown и опубликовать на любой другой платформе.
    • Github не нуждается в представлении, за исключением тех, кто хочет использовать его для документации по программному обеспечению. Он предоставляет вам собственную вики-систему и позволяет конвертировать вашу документацию в привлекательные витрины веб-сайта.

    Редакторы Markdown

    Поскольку документацию по программному обеспечению легче использовать в сети, ее необходимо создавать в надлежащем формате. Вот почему используются текстовые языки разметки. Самый популярный - это Markup, который легко конвертируется в HTML и не требует специальных знаний для его использования.Разметка используется на GitHub и Reddit и практически везде для веб-документации. Итак, вот несколько редакторов Markdown, которые могут быть полезны для создания документов для вашего проекта:

    Специальные инструменты для дорожной карты

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

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

    Инструменты для документации UX

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

    • Sketch - это простой, но мощный инструмент векторного дизайна с веб-приложением и настольным клиентом Mac. Sketch популярен и довольно прост, предлагая достаточно возможностей для проектирования интерфейсов.
    • InVision - один из самых популярных инструментов для создания прототипов. InVision славится своими функциями совместной работы и кроссплатформенными возможностями, что делает его отличным инструментом для разработки будущих интерфейсов.
    • UXPin - это инструмент для проектирования Mac и Windows, который позволяет создавать чертежи любого типа. Вы также можете загрузить свои эскизы или каркасы из других продуктов и сделать из них интерактивный прототип.
    • Adobe XD - где XD означает опыт дизайна.Продукт ориентирован на UX-специалистов. Это позволяет дизайнерам создавать прототипы с высокой точностью и делиться ими через приложение.

    Инструменты для документации API

    Чаще всего процесс создания документации API автоматизирован. Программисты или технические писатели могут писать документацию вручную или использовать генераторы документации API:

    • Swagger - это бесплатный программный сервис с самодокументированием, предназначенный для создания и обновления веб-сервисов и API RESTful.
    • RAML 2 HTML - это простой генератор документации, использующий спецификации RAML.

    Образцы и шаблоны программной документации

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

    • umkc.edu - список различных документов для тестирования, архитектуры, требований и планов.
    • Шаблоны Atlassian Confluence. Atlassian предоставляет готовые шаблоны проектной документации общего назначения со своим продуктом.
    • strongqa.com - шаблоны документации для специалистов по контролю качества. К ним относятся контрольные списки тестирования, шаблоны дымового тестирования, планы тестирования и многое другое.
    • ReadySET - это большая библиотека шаблонов документации по программному обеспечению в HTML, которая включает документы планирования, архитектуру, дизайн, требования, тестирование и многое другое.
    • ReadTheDocs - это универсальный шаблон, созданный на платформе ReadTheDocs, содержащий инструкции по написанию каждого типа документа, который может вам понадобиться, от архитектуры и диаграмм UML до руководств пользователя.

    Как писать документацию по программному обеспечению: общие советы

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

    Напишите достаточно документации

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

    Документирование - непрерывный процесс

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

    Документация - совместная работа всех членов команды

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

    Нанять технического писателя

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

    Использовать перекрестные ссылки

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

    Не игнорируйте глоссарии

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

    Заключительное слово

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

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

    .

    Введение - Документация системы документации

    Проблема, которую он решает

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

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

    Обычно это происходит не потому, что они недостаточно стараются. Обычно это происходит потому, что они делают это неправильно.

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

    «Секрет»

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

    И документация должна быть четко структурирована вокруг них, и все они должны храниться отдельно и отличаться друг от друга.

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

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

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

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

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

    .

    Об авторе

    admin administrator

    Отправить ответ

    avatar
      Подписаться  
    Уведомление о