Глоссарий#

API Документация#: API Документация (API Documentation) – это специальный тип документации, предназначенный для разработчиков, которые планируют интегрировать свои приложения с программным интерфейсом (API) продукта или сервиса. Документация API документация содержит описание доступных методов, параметров, форматов запросов и ответов, что позволяет разработчикам взаимодействовать с системой.
Docs-as-code#: Документация как код (Docs-as-Code) – это подход к созданию документации, при котором документация создается и хранится вместе с исходным кодом продукта или сервиса. Технический писатель может использовать инструменты контроля версий и системы сборки, чтобы автоматически создавать и обновлять документацию на основе изменений в коде.
Аналитик#: Аналитик – это специалист, который анализирует требования и данные, чтобы предоставить информацию и рекомендации для улучшения продукта или процессов. Их работа может влиять на контент технической документации.
Бизнес-аналитик#: Бизнес-аналитик – это специалист, который анализирует бизнес-процессы и требования, чтобы определить, как продукт или сервис может удовлетворить потребности компании и клиентов. Их работа может влиять на контент документации для руководства.
ГОСТ#: ГОСТ – это сокращение от “Государственный стандарт” и относится к стандартам и нормативам, утвержденным государственными органами в странах СНГ. ГОСТы могут использоваться в технической документации для обеспечения соответствия определенным стандартам.
Документация API#: Техническая документация, описывающая интерфейс программирования приложений (API), включая описание доступных методов, параметров, форматов запросов и ответов.
Документация для руководства#: Документация для менеджеров и руководителей (Management Documentation) – этот тип документации содержит обзорные и презентационные материалы о продукте или сервисе, предназначенные для менеджеров и руководителей. Она включает в себя сводную информацию о преимуществах продукта или сервиса, целевой аудитории, бизнес-преимуществах и т. д.
Документация для сетевых администраторов#: Документация для сетевых администраторов (Network Documentation) – этот тип документации содержит информацию и руководства для сетевых администраторов, чтобы иметь полное представление о сетевой инфраструктуре, ее конфигурации, настройке и поддержке.
Документация по администрированию#: Документация по администрированию (Administration Documentation) – этот тип документации предоставляет информацию администраторам системы о том, как управлять и поддерживать продукт или сервис. Она включает в себя инструкции по управлению пользователями, настройке параметров системы, резервному копированию и восстановлению данных и т. д.
Документация по безопасности (Security Documentation)#: Документация по безопасности (Security Documentation) – этот тип документации содержит руководства, политики и процедуры, связанные с безопасностью продукта или сервиса. Документация по безопасности обычно включает в себя инструкции по обеспечению безопасности данных и защите от угроз.
Документация по обучению#: Документация по обучению (Training Materials) – этот тип документации используется для обучения пользователей или персонала продукту, сервису или новой технологии. Документация по обучению может включать в себя обучающие видео, учебные материалы и практические задания.
Документация процесса разработки#: Этот термин относится к документации, которая описывает процесс разработки программного обеспечения, включая этапы, методологии и стандарты, используемые в процессе.
Документирование кода#: Процесс создания документации непосредственно в исходном коде программного обеспечения, чтобы облегчить его понимание и поддержание.
ИСО#: ИСО (ISO) – это сокращение от “Международная организация по стандартизации” (International Organization for Standardization). ИСО разрабатывает международные стандарты, которые также могут использоваться в технической документации.
Пользователи документации#: Люди или группы, которые взаимодействуют с документацией программного обеспечения для более полного понимания, использования и поддержания продукта или сервиса. Они опираются на различные типы документации, чтобы удовлетворить свои специфические потребности, начиная от новичков, ищущих базовые инструкции, до опытных разработчиков, ищущих подробные технические спецификации.
Программа и методика испытаний#: Программа и методика испытаний (Test Plan) – это документ, который описывает стратегию и планы для тестирования программного обеспечения. Технический писатель может использовать этот документ для понимания тестовых требований и включения соответствующей информации в документацию.
Руководство по устранению неполадок#: Руководство по устранению неполадок (Troubleshooting Guides) – этот тип документации предназначен для помощи пользователям в решении проблем, с которыми они могут столкнуться при использовании продукта или сервиса. Руководства по устранению неполадок содержат шаги по выявлению и решению проблем, а также рекомендации по предотвращению их возникновения.
Руководство пользователя#: этот тип документации предназначен для конечных пользователей продукта или сервиса. Руководства пользователя содержат подробные инструкции и советы по использованию функциональности, позволяющие пользователям эффективно взаимодействовать с продуктом или сервисом.
Спецификация продукта#: Техническая документация, которая содержит детальные технические характеристики и требования к продукту или его компонентам.
Справочная документация#: Справочная документация (Reference Documentation) – этот тип документации содержит справочную информацию о продукте или сервисе, такую как списки параметров, функций, команд или ключевых понятий. Справочная документация помогает пользователям быстро находить нужную информацию и служит как основа для других типов документации.
Тестировщик#: Тестировщик (специалист по тестированию) – это специалист, который выполняет тестирование программного обеспечения, чтобы обнаружить ошибки и недочеты. Технический писатель может сотрудничать с тестировщиками для проверки точности и полноты документации.
Техническая документация#: Техническая документация (Technical Documentation) – этот тип документации обычно предназначен для технических специалистов, таких как администраторы, разработчики и инженеры. Техническая документация может включать в себя технические спецификации, инструкции по установке и настройке, архитектурные диаграммы и другие технические детали.
Технические диаграммы#: Визуальные схемы и диаграммы, используемые в технической документации для наглядного представления архитектуры, процессов или данных.
Технический писатель#: Технический писатель – это специалист, который создает техническую документацию для программного обеспечения или других технических продуктов. Технический писатель предоставляет сложную информацию в понятной и доступной форме для целевой аудитории.
Техническое задание#: Техническое задание – это документ, который содержит детальное описание требований и спецификаций для разработки продукта или сервиса. Технический писатель может использовать техническое задание в качестве основы для создания технической документации.