Markdown Editor

Bộ mẫu nội dung hỗ trợ sản phẩm

Nội dung hỗ trợ theo KCS: kế hoạch và cấu trúc, cơ sở tri thức, FAQ, xử lý sự cố, lỗi đã biết, video, chỉ số và đánh giá.

10 mẫu trong 3 bước, theo thứ tự sử dụng. Mở mẫu bất kỳ trong trình soạn thảo, điền nội dung rồi xuất ra PDF, DOCX hoặc HTML.

Bước 1

Lập kế hoạch

  1. Documentation Plan Template

    Chuẩn

    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 Information Architecture Template (Diátaxis, llms.txt)

    Đầy đủ

    Docs site map and IA spec: audiences, Diátaxis content-type map, navigation, site-map tree, URL scheme, versioning, search facets, redirects, llms.txt

    Diátaxis; llms.txt proposal (2026-08-10); ISO/IEC/IEEE 26514:2022
Bước 2

Viết

  1. Knowledge Base Article Template

    Chuẩn

    KB article: metadata (article ID, product version, verified date, owner), environment, symptoms, cause, resolution, verification, related tickets, maintenance rules

  2. FAQ Template

    Chuẩn

    Evidence-based FAQ: question rules, when an FAQ is the wrong form, entry register with sources and review dates, canonical links, optional FAQPage note

  3. Troubleshooting Guide Template

    Chuẩn

    Troubleshooting guide: diagnostic first steps, symptom index, decision steps per problem with verification, data to collect before contacting support, known issues link

    Structure aligned with ISO/IEC/IEEE 26514:2022
  4. Known Issues Register Template

    Đầy đủ

    Living known-issues register: ID, symptom, affected versions and platforms, workaround, status, fix version, links, publication and review rules

    ISO/IEC/IEEE 26514:2022 (structure)
  5. Error Message Reference Template (RFC 9457)

    Chuẩn

    Error catalogue: code scheme, RFC 9457 problem details mapping, writing rules, entries with cause and fix, client handling, governance

    RFC 9457
  6. Screencast Script Template (WCAG 2.2 Captions, WebVTT)

    Đầy đủ

    Screencast script: narration vs action table, reset state, exact commands, zoom, pacing, chapters, WebVTT captions, transcript, audio description

    WCAG 2.2 SC 1.2.1 to 1.2.5; W3C WebVTT
Bước 3

Đo lường và thử nghiệm

  1. Docs Metrics Report Template (Privacy-First Docs Health)

    Đầy đủ

    Docs health report: coverage, freshness, quality (lint, links, accessibility), findability, usefulness, support impact, scorecard, actions, privacy-first

    ISO/IEC/IEEE 26511:2018 (structure); WCAG 2.2; GPC
  2. Documentation Content Audit Template (Inventory, ROT)

    Đầy đủ

    Docs content audit: criteria, page inventory with owner, last verified, signals, accuracy, ROT verdict and action, findings, gaps, remediation, redirects

    ISO/IEC/IEEE 26511:2018 and 26513:2017 (structure); WCAG 2.2