Простой язык с длинными обязательными фразами

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

Некоторые из наших соглашений требуют, чтобы мы всегда использовали полную фразу, указанную на экране: если мы говорим о поле со списком категории, но метка говорит «Пожалуйста, выберите категорию:» [так в оригинале], это то, что мы должны использовать.

Еще одно соглашение относится к сочетаниям клавиш - они всегда состоят из нескольких «слов», поскольку мы используем пробел (или я использую неразрывный пробел) между каждым его элементом. Итак, у нас есть CTRL + INSERT + T для списка таблиц.

Как вы, возможно, заметили, у меня есть склонность к длинным предложениям с большим количеством предложений. Я использую Hemingway для проверки каждого раздела на Plain Language и пытаюсь пересмотреть сложные/очень сложные предложения.

Проблема в том, что мои предложения часто очень длинные , и это не моя вина!

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

Это "обман"? Являются ли эти «условия искусства» и можно ли сказать, что «Ctrl + INSert + цифровая клавиатура 6» понимается как «слово»?

Должны ли только сочетания клавиш считаться 1 словом, так как пользователи могут знать их из других применений программы чтения с экрана (поэтому замена их мысленно на «X» для проверки простого языка допустима), но «флажок конверта для отправки электронной почты» по-прежнему имеет считать как 4 слова, так как они будут новыми для пользователя? Или только первое использование внутри раздела?

Примечание. На моем рабочем месте нельзя использовать 2-е лицо, несмотря на то, что PlainLang поощряет личные местоимения — я уже «теряю» слова, постоянно говоря «пользователь» вместо «вы».

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

Здесь много вопросов… Можно ли использовать предполагаемое второе лицо , где «вы/пользователь» просто пропущено?
Да, я много чего использую. «Нажмите Insert + F5, перейдите с помощью стрелок вниз к наиболее точному варианту, затем нажмите Enter, чтобы активировать его».
дааа, это длинное предложение... И это нужно каждый раз?
Вы можете попробовать обмануть программное обеспечение, заменив пробелы в этих фразах каким-нибудь специальным символом, который вы обычно не используете; например '^', который вы можете позже заменить глобальным пробелом (или неразрывным пробелом). Итак, «CTRL^+^INSERT^+^T», и, возможно, Хемингуэй посчитает это за одно слово.
Интересно, существуют ли соглашения, специфичные для программ чтения с экрана, которые должны учитывать это. На этот вопрос было бы полезно получить информацию от кого-то, кто регулярно использует программу чтения с экрана.
Поддерживают ли ваши инструменты переменные в исходном коде? И если да, то Хемингуэй считает по выходу или по вашему источнику?
Я использую неразрывный пробел (ctrl+shift+spacebar или ^s при поиске и замене соединений с командными клавишами). Мой «инструмент» — это просто Word — это все, что у нас есть. Хемингуэй — это просто инструмент, который я использую, чтобы противодействовать моей склонности связывать все в чудовищную фразу 1800-х годов. Я просто пытаюсь отредактировать все, что в моих силах, прежде чем объявить этот черновик «готовым» и отправить его на экспертную оценку и проверку руководителем группы. (Экспертная оценка — всего на 6 месяцев больше опыта, чем у меня. У руководителя группы более 12 лет, но он всегда перегружен.)
Кроме того, все говорят, что черновики сильно размечены, и я хотел бы минимизировать или упредить многое из этого. (Я склонен чрезмерно эмоционально реагировать, хотя знаю, что не должен.) Этот черновик занимает около 40 страниц, если учесть оглавление и безумие форматирования.
Я только что сделал еще одно редактирование, на этот раз распечатав его на бумаге, а затем читал вслух на другом компьютере с немного другой версией программы для чтения с экрана. (к счастью, в офисе больше никого нет.) У меня еще миллиард правок. конечно.

Ответы (1)

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

Сами Хемингуэи заявляют:

Но что, если я хочу нарушить правила?

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

Раньше я писал инструкции для IBM и Sun Microsystems. Для новых пользователей я бы попытался подражать форматированию книги для чайников. В Word 2007 для чайников есть функция Look Inside , чтобы вы могли увидеть, как они с этим справляются.

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

ИМПОРТ ИЗОБРАЖЕНИЯ В ДОКУМЕНТ MS WORD

Импортировать изображения в Word очень просто, просто выполните следующие действия:

  1. Щелкните левой кнопкой мыши пункт меню ВСТАВИТЬ . Появится всплывающее меню.

  2. Во всплывающем меню выберите ИЗОБРАЖЕНИЯ . Появится боковое меню.

  3. В боковом меню выберите ИЗОБРАЖЕНИЕ ИЗ ФАЙЛА .

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

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

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

Нет изображений — эти пользователи слабовидящие. Вещи уже пронумерованы и настолько кратки, насколько я могу их сделать.
Тогда возможно ли, что вы уже проделали большую работу, а Хемингуэй заставляет вас сомневаться в собственных способностях?
Может быть. Я никогда раньше не писал технический документ (хотя я преподавал техническое письмо), и у меня никогда не было столько времени, чтобы вычитывать/редактировать что-то черт возьми. Как инструктор, это было написать и пойти (листы с заданиями) или дать несколько советов в отзывах студентов. У нас не так много сотрудничества в этом офисе, на что я отчасти и надеялся.
@April, неужели в вашем офисе нет никого, кто мог бы проверить вашу работу и убедиться, что вы движетесь в правильном направлении? Если вы уже отформатировали его таким образом, просто, как книга для чайников, следуя рекомендациям компании, я бы сказал, что вы выполнили свою работу. Единственный способ узнать наверняка — передать его и получить обратную связь. Но мне кажется, что вы, возможно, слишком много думаете и слишком много анализируете с такими инструментами, как Хемингуэй. Это просто инструмент, который поможет вам, а не слепое следование. Возможно, оставьте комментарий здесь и дайте нам знать, довольны ли они этим! Удачи.
Я сделал редактирование вслух, поэтому я нашел некоторые ошибки (некоторые форматирование, некоторые опечатки), но позже сегодня я объявлю, что это «сделано». С одним соавтором я встречался немного, но у нее есть свои проекты. Она сказала мне, что первый черновик — это не то, что я бы назвал первым черновиком, но он должен быть «максимально полным/правильным». (Частично я задал этот вопрос из-за драйва вопросов о тегах недели, а не из-за беспокойства)
Простой язык с длинными обязательными фразами
СпросиСетьПолитика конфиденциальности1y, 0v