Markdown Editor

Набір документації апаратних продуктів

Документація фізичних і підключених продуктів: інструкції з використання, встановлення, посібники користувача й адміністратора, локалізація.

Шаблонів: 9, кроків: 4, у порядку використання. Відкрийте будь-який шаблон у редакторі, заповніть його та експортуйте в PDF, DOCX або HTML.

Крок 1

Планування

  1. Documentation Plan Template

    Стандарт

    Docs plan: audiences and tasks, deliverables inventory, IA, style, pipeline, review, localisation, accessibility, metrics, optional agile delivery and docs DoD

    Structure aligned with ISO/IEC/IEEE 26511:2018 and 26515:2018; Diátaxis
  2. Documentation Acquisition Specification and RFP Template (ISO/IEC/IEEE 26512)

    Стандарт

    Outsourced documentation RFP: objectives, users, deliverables, statement of work, schedule, terms, proposal outline, weighted evaluation, acceptance

    ISO/IEC/IEEE 26512:2026
Крок 2

Посібники

  1. Instructions for Use Template (IEC/IEEE 82079-1)

    Повний

    Product IFU: audience, applicable laws, production process, validation, safety messages, intended use, setup, operation, maintenance, disposal

    IEC/IEEE 82079-1:2019
  2. Installation and Configuration Guide Template (ISO/IEC/IEEE 26514)

    Повний

    Install guide – requirements, checklist, per-platform steps, verification, config parameters, upgrade, uninstall, hardening

    ISO/IEC/IEEE 26514:2022
  3. User Manual Template (ISO/IEC/IEEE 26514)

    Повний

    Full user manual per ISO/IEC/IEEE 26514 – conventions, notices, concepts, task procedures, reference, errors, accessibility

    ISO/IEC/IEEE 26514:2022
  4. Administrator Guide Template (ISO/IEC/IEEE 26514)

    Повний

    Admin guide – roles, architecture, access, backup/restore, monitoring, maintenance, scaling, security ops, DR, audit

    ISO/IEC/IEEE 26514:2022
Крок 3

Випуск і передавання

  1. Localization Brief Template (ISO 17100, XLIFF)

    Повний

    Translation brief: locales, source freeze, scope, termbase and do-not-translate list, style per locale, MT post-editing policy, i18n readiness, LQA, schedule

    ISO 17100:2015; ISO 18587:2017; XLIFF 2.1
  2. Termbase Template (ISO 704, TBX)

    Повний

    Concept-oriented terminology register: definition rules, usage status, context, source, relations, per-locale equivalents, do-not-translate terms, TBX export

    ISO 704:2022; ISO 30042:2019 (TBX)
Крок 4

Рев'ю Well-Architected

  1. Documentation Review Checklist Template (WCAG 2.2, Diátaxis)

    Повний

    Docs review gate: roles, severity, accuracy, task test, style, terms, links, code samples, WCAG 2.2, localisation, Diátaxis type, findings, sign-off

    ISO/IEC/IEEE 26513:2017 (structure); WCAG 2.2; Diátaxis