troubleshooting guide
руководство по устранению неисправностей
—
[Интент]
Тематики
Смотреть что такое «troubleshooting guide» в других словарях:
User guide — A user guide or user s guide, also commonly known as a manual, is a technical communication document intended to give assistance to people using a particular system.[1] It is usually written by a technical writer, although user guides are written … Wikipedia
Quality Reference Guide (McDonald’s) — QRG, or Quality Reference Guide, is a book available to McDonald s employees containing details of all food products sold in their stores (excluding promotional items). The QRG is updated yearly or bi yearly and is available to order by every… … Wikipedia
Windows NT — Not to be confused with Windows NT 4.0. Windows NT Company / developer Microsoft Programmed in C, C++ and Assembly language … Wikipedia
Windows Mobile Device Center — Infobox Software name = Windows Mobile Device Center caption = Windows Mobile Device Center in Windows Vista developer = Microsoft released = October 7, 2006 latest release version = 6.1.6965 latest release date = August 20, 2007 operating system … Wikipedia
Ethernet frame — A data packet on an Ethernet link is called an Ethernet frame. A frame begins with Preamble and Start Frame Delimiter. Following which, each Ethernet frame continues with an Ethernet header featuring destination and source MAC addresses. The… … Wikipedia
Ethernet over twisted pair — cable (upper) and 8P8C plug (lower) Ethernet over twisted pair technologies use twisted pair cables for the physical layer of an Ethernet computer network. Other Ethernet cable standards employ coaxial cable or optical fiber. Early versions… … Wikipedia
Network Access Protection — (NAP) is a Microsoft technology for controlling network access of a computer host based on the system health of the host, first introduced in Windows Server 2008. With Network Access Protection, system administrators of an organization s computer … Wikipedia
Windows NT 3.51 — Part of the Microsoft Windows family … Wikipedia
Windows NT 3.51 — Windows NT 3.51 … Википедия
Python regius — Taxobox name = Python regius regnum = Animalia phylum = Chordata subphylum = Vertebrata classis = Reptilia ordo = Squamata subordo = Serpentes familia = Pythonidae genus = Python species = P. regius binomial = Python regius binomial authority =… … Wikipedia
troubleshooting guide
Смотреть что такое «troubleshooting guide» в других словарях:
User guide — A user guide or user s guide, also commonly known as a manual, is a technical communication document intended to give assistance to people using a particular system.[1] It is usually written by a technical writer, although user guides are written … Wikipedia
Quality Reference Guide (McDonald’s) — QRG, or Quality Reference Guide, is a book available to McDonald s employees containing details of all food products sold in their stores (excluding promotional items). The QRG is updated yearly or bi yearly and is available to order by every… … Wikipedia
Windows NT — Not to be confused with Windows NT 4.0. Windows NT Company / developer Microsoft Programmed in C, C++ and Assembly language … Wikipedia
Windows Mobile Device Center — Infobox Software name = Windows Mobile Device Center caption = Windows Mobile Device Center in Windows Vista developer = Microsoft released = October 7, 2006 latest release version = 6.1.6965 latest release date = August 20, 2007 operating system … Wikipedia
Ethernet frame — A data packet on an Ethernet link is called an Ethernet frame. A frame begins with Preamble and Start Frame Delimiter. Following which, each Ethernet frame continues with an Ethernet header featuring destination and source MAC addresses. The… … Wikipedia
Ethernet over twisted pair — cable (upper) and 8P8C plug (lower) Ethernet over twisted pair technologies use twisted pair cables for the physical layer of an Ethernet computer network. Other Ethernet cable standards employ coaxial cable or optical fiber. Early versions… … Wikipedia
Network Access Protection — (NAP) is a Microsoft technology for controlling network access of a computer host based on the system health of the host, first introduced in Windows Server 2008. With Network Access Protection, system administrators of an organization s computer … Wikipedia
Windows NT 3.51 — Part of the Microsoft Windows family … Wikipedia
Windows NT 3.51 — Windows NT 3.51 … Википедия
Python regius — Taxobox name = Python regius regnum = Animalia phylum = Chordata subphylum = Vertebrata classis = Reptilia ordo = Squamata subordo = Serpentes familia = Pythonidae genus = Python species = P. regius binomial = Python regius binomial authority =… … Wikipedia
Вредные советы: как правильно писать техническую документацию? Часть третья и последняя
Советы по грамотному написанию технической документации для пользователей.
Часть 3 (заключительная)
Заключение руководства нашего технического писателя Андрея Старовойтова, которое поможет сделать вашу пользовательскую документацию проще и понятнее.
На этот раз мы поподробнее рассмотрим:
Такие топики нужны, чтобы предоставить пользователям дополнительную техническую информацию и тем самым не перегружать task-топик.
Обратите внимание, что в них должна быть именно дополнительная информация, но не способ решения задачи.
Концептуальные топики хорошо использовать для того, чтобы:
Таким образом, опытный пользователь, читая task-топик, не будет жаловаться: «Зачем вы мне расписываете, что это такое, я и так знаю…». А тот, кто не знает, увидит ссылку на концептуальный топик и прочитает.
Обычно заголовки концептуальных топиков начинаются с:
Справочные топики (reference pages):
В таких топиках описывается различная справочная информация, к которой пользователь может при необходимости обращаться.
Хорошими примерами таких топиков могут служить:
Топики, которые описывают, как решить какую-нибудь проблему (troubleshooting pages)
Такие топики помогают пользователю преодолеть препятствие или решить какую-нибудь проблему. У troubleshooting-топиков могут быть следующие сценарии:
Если пользователь хочет сделать что-то, но не знает как – это надо описывать не в troubleshooting, а task-топике.
Troubleshooting подразумевает, что пользователь попытался сделать что-то (по инструкции task-топика), но возникла какая-то проблема, и пользователь не знает, как ее решить.
Например, топик, который описывает, как использовать внешний диск в гостевой операционной системе — это task-топик.
А топик, который описывает возможные проблемы – «Не могу подключить внешний диск» (“I’m having problems connecting a hard disk”) – это troubleshooting-топик. Его содержание подразумевает, что пользователь следовал инструкциям, но по какой-то причине у него не получилось.
Если вы пишете task-топик, и какой-то шаг в инструкции может вызвать небольшие затруднения, допускается описать это в том же шаге или топике. Для небольших затруднений необязательно писать отдельный troubleshooting-топик.
Например, в конце топика, который описывает, как изменять быстрые сочетания клавиш, можно добавить: «некоторые шорткаты нельзя изменить или удалить» (“Some key combinations can’t be edited or deleted”).
Обычно troubleshooting-топики имеют структуру схожую с task-топиками.
Хорошо, когда заголовок troubleshooting-топика выражает проблему пользователя от первого лица. Например:
Правильно: My USB Device Isn’t Working
Неправильно: My USB device isn’t working
Сразу после заголовка предоставьте пользователям информацию, которую им надо знать прежде всего.
Перед последовательностью шагов, которые надо предпринять, чтобы решить проблему, пишите вводную фразу. Не забывайте в конце ставить двоеточие.
Если решение проблемы представляет собой набор последовательных действий:
В таких случаях вводную фразу нужно делать по тем же принципам, что и для task-топиков (см. 2-ую часть советов), а именно – используйте те же слова, что и в формулировке задачи.
Например, вы пишите troubleshooting-топик, в котором объясняете, почему пользователь не может открыть конфигурацию виртуальной машины (пункт меню выделен серым и неактивен):
Заголовок: «Я не могу открыть настройки виртуальной машины» (“I Can’t Open the Virtual Machine Settings”)
Введение: «Если вы не можете открыть настройки виртуальной машины (пункт меню выделен серым), то наиболее вероятная причина в том, что виртуальная машина не выключена.»
Далее вводная фраза: «Чтобы открыть настройки виртуальной машины:» (в этой фразу используются те же слова, что и в формулировке задачи, которую надо выполнить)
А дальше уже шаги – 1) Убедитесь что машина выключена. Если она работает, нажмите там-то и там-то. 2) Потом сделайте то-то.
Если у проблемы несколько решений:
В таких случаях, вводная фраза должна содержать слова:
— «попробуйте эти способы» (“try these solutions”),
— «попробуйте предпринять следующее» (“try the following”),
— «убедитесь, что» (“make sure that”) и пр.
Вот несколько примеров из английской документации:
Page Title: I Can’t Activate Parallels Desktop
Task Covers: A list of things to check
Step Heading: If you’re having trouble activating Parallels Desktop, make sure that…
Page Title: Windows Seems Slow
Task Covers: A list of things to try
Step Heading: If Windows performance seems slow, try the following…
Page Title: A Message Says “No Macs Connected”
Task Covers: Several things to check or try
Step Heading: If you don’t see your Mac in the list of Macs
Информация, необходимая для решения проблемы (steps to solution)
Этот раздел включает все то, что пользователю надо знать и/или предпринять.
Если решений несколько:
В таких случаях описывайте каждый способ, используя буллиты (об этом более подробно можно почитать во второй части советов). Если какой-то способ сложный, и вы его уже детально описали в другом топике, просто дайте ссылку.
Если то, что надо сделать, уже описано где-то в другом топике:
Просто дайте ссылку на этот топик.
Если нет конкретной инструкции, что можно было бы сделать, чтобы решить проблему:
Предоставьте любую дополнительную информацию, которая может помочь пользователю самому понять, в чем может быть причина проблемы.
В заключении можно предоставить дополнительную информацию, относящуюся к выполнению задачи или возможным вариантам решения проблемы. Более подробную информацию об использовании outro можно прочитать во второй части советов.
Использование графики (скриншоты, диаграммы, схемы и т. д.)
Скриншоты и схемы могут помочь пользователям значительно лучше понять то, что написано в топике.
Когда использовать графику:
Под каждым шагом скриншот вставлять не надо – пользователь просто не будет знать, куда смотреть, постоянно сравнивая экран и скриншот.
Скриншоты надо вставлять тогда, когда они существенно помогут понять, что написано в инструкции.
Ниже представлены несколько рекомендаций, где и как размещать графику на странице.
1) Если скриншот отражает концептуальную информацию или результат выполнения задачи, можно вставить его в или после intro.
Вот пример из английской документации, на котором показан топик, описывающий оконный режим работы Windows. Скриншот, который показывает, что будет после такого переключения, вставлен после введения и перед самой инструкцией, как в этот режим переходить:
2) Если скриншот относится к какому-то конкретному шагу в инструкции, вставляйте его после или внутри этого шага:
Если вам надо вставить скриншот кнопки, иконки или другого элемента интерфейса, надо вставлять его после названия этого элемента:
Не используйте графику для иллюстрации очевидных вещей
Если конкретно, то не используйте скриншоты, чтобы иллюстрировать:
1) How to capitalize titles:
capitalization Three styles of capitalization are available: sentence style, title style, and all caps.
capitalization (sentence style): When you use sentence-style capitalization, capitalize the first letter of the first word, as well as the first letter of any proper nouns and proper adjectives.
capitalization (title style): Use title-style capitalization for book titles, part titles, chapter titles, and section titles (text heads).
Follow these rules when you use title-style capitalization. Capitalize every word except:
Start Up the ComputerLog
In to the ServerGet
Started with Parallels Desktop
• The first and last word, regardless of the part of speech:
For Linux Users
What Parallels Tools Are For
• The second word in a hyphenated compound:
Correct: High-Level Events, 32-Bit Addressing
Incorrect: High-level Events, 32-bit Addressing
Exceptions: Built-in, Plug-in
• The words Are, If, Is, It, Than, That, and This
2) How to use the word “click”:
click Use click to describe the act of positioning the pointer on an object onscreen and briefly pressing and releasing the mouse button. Don’t use click on. Because most users know what clicking is, you need to define it only in documentation designed for beginning users, such as tutorials.
Correct: Click Mac if you want to use the USB device with Mac OS X.
Incorrect: Point to Mac and click it if you want to use the USB device in Mac OS X.
click on Don’t use; use click.
Use email. Don’t use e-mail.
Use if to express a condition. Use whether to express alternatives.
Correct: Check whether Parallels Tools have been installed.
Incorrect: Check if Parallels Tools have been installed.
Correct: Click Mac if you want to use the USB device with Mac OS X.
5) How to use product names:
Follow the capitalization style on the product’s packaging. Use the full product name for its first occurrence within a section of text (for example, a chapter). Thereafter, when applicable use a shortened version of the product name.
For example: Parallels Desktop 14 for Mac: On first occurrence within a section of text, use Parallels Desktop 14 for Mac.
On subsequent occurrences, use Parallels Desktop.
В этих 3 частях руководства мы постарались собрать воедино, обобщить и структурировать советы, которые помогут сделать вашу документацию проще и понятнее.
Мы не настаиваем, что писать надо именно так – подходов к документированию и приемов много. Смотрите по обстановке и используйте те, которые вам подходят.
troubleshooting guide
Смотреть что такое «troubleshooting guide» в других словарях:
User guide — A user guide or user s guide, also commonly known as a manual, is a technical communication document intended to give assistance to people using a particular system.[1] It is usually written by a technical writer, although user guides are written … Wikipedia
Quality Reference Guide (McDonald’s) — QRG, or Quality Reference Guide, is a book available to McDonald s employees containing details of all food products sold in their stores (excluding promotional items). The QRG is updated yearly or bi yearly and is available to order by every… … Wikipedia
Windows NT — Not to be confused with Windows NT 4.0. Windows NT Company / developer Microsoft Programmed in C, C++ and Assembly language … Wikipedia
Windows Mobile Device Center — Infobox Software name = Windows Mobile Device Center caption = Windows Mobile Device Center in Windows Vista developer = Microsoft released = October 7, 2006 latest release version = 6.1.6965 latest release date = August 20, 2007 operating system … Wikipedia
Ethernet frame — A data packet on an Ethernet link is called an Ethernet frame. A frame begins with Preamble and Start Frame Delimiter. Following which, each Ethernet frame continues with an Ethernet header featuring destination and source MAC addresses. The… … Wikipedia
Ethernet over twisted pair — cable (upper) and 8P8C plug (lower) Ethernet over twisted pair technologies use twisted pair cables for the physical layer of an Ethernet computer network. Other Ethernet cable standards employ coaxial cable or optical fiber. Early versions… … Wikipedia
Network Access Protection — (NAP) is a Microsoft technology for controlling network access of a computer host based on the system health of the host, first introduced in Windows Server 2008. With Network Access Protection, system administrators of an organization s computer … Wikipedia
Windows NT 3.51 — Part of the Microsoft Windows family … Wikipedia
Windows NT 3.51 — Windows NT 3.51 … Википедия
Python regius — Taxobox name = Python regius regnum = Animalia phylum = Chordata subphylum = Vertebrata classis = Reptilia ordo = Squamata subordo = Serpentes familia = Pythonidae genus = Python species = P. regius binomial = Python regius binomial authority =… … Wikipedia
troubleshooting
1 troubleshooting
2 troubleshooting
3 troubleshooting
4 troubleshooting
5 troubleshooting
нахождение и устранение неисправностей
—
[Я.Н.Лугинский, М.С.Фези-Жилинская, Ю.С.Кабиров. Англо-русский словарь по электротехнике и электроэнергетике, Москва, 1999]
Тематики
отыскание повреждений
выявление недостатков
устранение неполадок
выявление ошибок
поиск неисправностей
диагностика
отладка
—
[Л.Г.Суменко. Англо-русский словарь по информационным технологиям. М.: ГП ЦНИИС, 2003.]
Тематики
Синонимы
поиск неисправностей
Совокупность действий, связанных с обнаружением и локализацией неисправностей в процессе отладки или эксплуатации оборудования с целью их последующего устранения.
[Л.М. Невдяев. Телекоммуникационные технологии. Англо-русский толковый словарь-справочник. Под редакцией Ю.М. Горностаева. Москва, 2002]
Тематики
6 troubleshooting
7 troubleshooting
8 troubleshooting
9 troubleshooting
10 troubleshooting
11 troubleshooting
12 troubleshooting
13 troubleshooting
14 troubleshooting
15 troubleshooting
16 troubleshooting
17 troubleshooting
18 troubleshooting
19 troubleshooting
20 troubleshooting
См. также в других словарях:
Troubleshooting — is a form of problem solving. It is the systematic search for the source of a problem so that it can be solved. Troubleshooting is often a process of elimination eliminating potential causes of a problem. Troubleshooting is used in many fields… … Wikipedia
Troubleshooting — [dt. Fehlersuche] das, Auffinden, Analysieren und Beheben von Fehlern oder Problemen, die bei Hard und Software oder bei Verbindungssystemen und Netzwerken auftreten … Universal-Lexikon
Troubleshooting — Cet article possède un paronyme, voir : Troubleshooters. L expression anglaise troubleshooting ( élimination de problème ) désigne un processus de recherche logique et systématique de résolution de problème. Ce processus passe par la… … Wikipédia en Français
troubleshooting — troubleshoot UK US /ˈtrʌblˌʃuːt/ verb [I or T] (troubleshot, troubleshot) ► to try to solve problems for a person or organization: »She meets daily with various stakeholders to troubleshoot any issues or potential problems. ► to try to find the… … Financial and business terms
troubleshooting — noun The identification and resolution of problems, especially problems of a technical nature. When it comes to computer problems, his troubleshooting is first rate … Wiktionary
troubleshooting — [[t]trʌ̱b(ə)lʃuːtɪŋ[/t]] N UNCOUNT Troubleshooting is the activity or process of solving major problems or difficulties that occur in a company or government … English dictionary
troubleshooting — gedimų paieška statusas T sritis automatika atitikmenys: angl. failure search; fault finding; fault lookup; fault tracing; troubleshooting vok. Fehlersuche, f rus. локализация неисправностей, f; локализация повреждений, f; поиск неисправностей, m … Automatikos terminų žodynas
troubleshooting — n. locating of malfunctions; mediationv. spot problems; mediate, settle disagreements … English contemporary dictionary
troubleshooting — noun analyse and solve problems for an organization. → troubleshoot … English new terms dictionary
troubleshooting — UK [ˈtrʌb(ə)lˌʃuːtɪŋ] / US [ˈtrʌb(ə)lˌʃutɪŋ] noun [uncountable] the process of finding and repairing problems or faults in something … English dictionary