Чтобы не происходило как пишется

Несколько лет назад я услышал от одного коллеги историю. он в то время работал начальником отдела технической документации в it

Несколько лет назад я услышал от одного коллеги историю. Он в то время работал начальником отдела технической документации в IT компании. Дело было на собрании, посвященном знакомству с новым техническим директором. Тот, пожав моему коллеге руку и узнав о его роли, пошутил: «Документация? Так ее же не читает никто! Двадцать первый век на дворе».

Вряд ли кому-то из нас было бы приятно оказаться на месте этого человека. Но, коллеги, положа руку на сердце, нет ли в подобном отношении нашей вины? К сожалению, я нередко сталкиваюсь с ситуациями, в которых документация, официальная или нет, не может мне помочь. А ведь ее кто-то писал, тратил время и усилия. Зачем это было сделано? И как можно сделать лучше? В этой статье я поделюсь своим видением того, как писать документацию, приносящую реальную пользу читателям.

Возможно, что-то из того, что написано в моей статье, покажется вам «капитанским». Ничего страшного! Это значит, что вы уже владеете лучшими практиками написания документации. Статья в первую очередь адресована людям, недавно пришедшим в профессию, поэтому, коллеги, если я что-то упустил, или если у вас есть свой взгляд на вещи — пожалуйста, отпишитесь в комментариях.

Что такое «хорошая документация»?

Итак, начнем. Что же вообще такое «хорошая документация»? Подробная? Или написанная с юмором, чтобы было не скучно читать? Для кого-то самая лучшая документация — толстый том, который можно подложить под ножку стола, чтобы не шатался. На мой взгляд, хорошая документация — такая, которая выполняет свою задачу.

А в чем задача документации? Ответов на этот вопрос может быть много. Документация может использоваться для обучения, для справки, или даже служить своего рода рекламой. Я слышал от коллеги историю о том, как менеджер по продукту просил ее написать документацию для нового продукта за три дня, делая упор на том, что «все равно какую, ее никто читать не будет, она нужна только чтобы проект сдать». И это тоже задача, хоть и очень грустная.

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

Хорошо, допустим. А что позволяет документации выполнять задачу? Какая она, хорошая документация, и как ее создавать? Есть ряд практик, которым мы следуем, когда пишем документацию в Plesk, и сегодня я хотел бы о них рассказать. Итак…

Хорошую документацию легко найти

Времена, когда лежащий в коробке с программой мануал был единственным источником информации для пользователя, ушли безвозвратно. В наши дни каждый имеет доступ к практически неограниченному количеству информации, и у технических писателей больше нет монополии на внимание пользователя. Как бы ни была хороша ваша документация, если она занимает низкую позицию в выдаче поисковых систем, ее просто никто не прочтет. Чтобы ваша документация приносила пользу, позаботьтесь о ее находимости (findability).

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

  1. Человек начинает пользоваться Plesk.

  2. Человек сталкивается с затруднением.

  3. Человек пытается разобраться с затруднением самостоятельно.

  4. Когда желание преодолеть затруднение пересиливает нежелание тратить время на поиск помощи, человек вводит запрос в Google и открывает первую ссылку в выдаче.

Замечу, что по данным Google Search Console запросы пользователей не включают слово «документация». Люди ищут «plesk login», «plesk install», «plesk ftp» и так далее. Скорее всего, запросы, по которым пользователи находят документацию вашего продукта, выглядят похоже. Чтобы пользователям было проще найти вашу документацию, важно использовать те термины и формулировки, которые они используют. Это особенно важно в случае если поисковая система на вашем сайте документации не очень хорошо производит нечеткий поиск.

Раз уж мы заговорили о находимости, я хотел бы также познакомить вас с терминами «информационное фуражирование» и «информационный запах». Поведение человека, ищущего информацию, похоже на поведение зверя в поисках пищи. Зверь хочет получить максимум калорий, затратив минимум сил. Разыскивая пищу, зверь полагается на запах, который говорит ему, насколько велики шансы найти пропитание там, где он сейчас находится. 

Так же и человек хочет получить максимально полезный и информативный ответ на вопрос, затратив минимум усилий и времени. Попадая на новую страницу в Интернете, человек пробегает по ней глазами в поиске свидетельств того, что здесь он сможет найти ответ на интересующий его вопрос. Ключевые слова, заголовки, ссылки, и так далее и формируют тот самый «информационный запах». Компания Nielsen Norman Group провела исследование среди пользователей и выяснила, что если в течение первых десяти секунд посетитель не обнаруживает на странице сильный информационный запах, он скорее всего уйдет с нее и продолжит поиск в другом месте.

Как же привлечь внимание пользователя за те десять секунд, что у нас есть? Отличная практика — разместить в самом начале каждого раздела краткое (не больше трех-четырех предложений) описание его содержания, в идеале оформив его так, чтобы оно визуально отличалось от остального текста и бросалось в глаза. Сюда же можно добавить ссылки на схожие по смыслу разделы, чтобы облегчить дальнейший поиск пользователям, оказавшимся не там, где они планировали. Вот как может выглядеть такое описание:

В этом разделе вы узнаете, как создать новый FTP аккаунт в Plesk. Если вы хотите узнать, как изменить логин или пароль существующего FTP аккаунта, пройдите по ссылке.

Благодаря этой секции попавший на эту страницу пользователь сможет быстро сориентироваться и понять, содержит ли просматриваемый им раздел ответ на интересующий его вопрос.

Хорошую документацию легко понять

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

В работе я руководствуюсь высказыванием Антуана де Сент-Экзюпери: «Совершенство достигнуто не тогда, когда нечего добавить, а тогда, когда нечего убрать». Когда готов первый черновик документации для новой фичи, первое, на что я смотрю — можно ли сделать текст проще и короче. Что помогает в этом?

  • Часто употребляемые слова. Избегайте канцелярита, не пишите «произвести манипуляцию с элементом управления» когда хотите сказать «нажать кнопку».

  • Простые предложения.

  • Короткие (4–6 предложений) абзацы.

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

От одной коллеги я слышал о таком любопытном юзкейсе: в ее организации документацию пишут на английском языке, но клиенты пользуются ей по всему миру. Поэтому технические писатели намеренно используют максимально простой английский, чтобы встроенные в современные браузеры автоматические переводчики могли как можно более точно выполнить перевод. Таким образом, клиенты по всему миру могут читать документацию на родном языке, а организация не платит за перевод. Это было бы невозможно без осознанных усилий, направленных на то, чтобы сделать текст документации максимально простым и понятным.

Что еще можно сделать, чтобы ваша документация стала проще для понимания? Соблюдать меру при использовании вспомогательных средств, таких как снимки экрана, графики, таблицы и видео. Все они помогают нам донести до читателя информацию и сделать ее более наглядной, но перенасытить ими документацию так же просто, как пересолить суп.

Некоторое время назад я искал технического писателя в свою команду. В тестовом задании, предлагавшемся соискателям, была просьба написать короткую инструкцию, объясняющую, как установить расширение в Chrome. Один из кандидатов снабдил каждый шаг полноразмерным снимком экрана, что раздуло небольшую инструкцию на пару страниц. Чем это плохо? Напомню, что попадая на новую страницу, человек не начинает вдумчиво читать, он пробегается по ней глазами. Большой объем вкупе с обилием иллюстраций отпугивает, несложная процедура кажется чем-то сродни запуску ядерного реактора. Сложилось ощущение, что у соискателя были какие-то установки («снимки экрана — это хорошо»), но не было понимания, что любым инструментом нужно пользоваться к месту и в меру. Отбор он не прошел.

Хорошая документация описывает сценарии

Классический подход к документированию интерфейсов подразумевает последовательное описание индикаторов и элементов управления, размещенных на том или ином экране. Типичный пример — снимок экрана с цифрами-выносками, а под ним — нумерованный список, перечисляющий все, что пользователь и так видит. Введите имя пользователя в поле «Имя пользователя». Нажмите Ok, когда захотите закончить операцию.

Проблема этого подхода в том, что он не отражает то, как люди пользуются документацией. Если когда-то и были времена, в которые человек, купив программу, внимательно читал от корки до корки лежащий в коробке мануал, они остались в прошлом. Никто не читает документацию, чтобы узнать, что делают все кнопки на экране «Создать домен». Пользователи обращаются к документации, когда у них возникают затруднения с выполнением какого-то реального сценария, связанного с использованием продукта (создать почтовый ящик, защитить сайт SSL сертификатом, и так далее).

В свете этого, когда пользователь обращается к документации, написанной с использованием классического подхода, ему приходится конструировать процедуру самостоятельно, зачастую из информации, разбросанной по разным разделам. «Хмм, наверное, мне нужно сперва сделать вот это действие, потом вот это, а затем вот это?» И тут сразу возникают следующие проблемы:

  • Пользователю приходится тратить время и усилия на то, чтобы сконструировать процедуру.

  • Сконструированная пользователем процедура может быть неполной или вовсе неверной.

  • Каждому пользователю приходится конструировать процедуру самостоятельно. Таким образом, чем больше у вас посетителей, тем больше времени они совместно потратят.

  • Если сценарий не очень частый, пользователю, возможно, придется вернуться к нему через продолжительное время. К тому времени он может уже забыть о том, как выполнять нужную процедуру, и ему потребуется конструировать ее заново.

Всех этих проблем можно избежать, применяя сценарный подход к написанию документации. Это подразумевает, что вместо описания всех элементов интерфейса и их свойств, вы описываете последовательность действий, которые необходимы для выполнения того или иного реального сценария. Например:

  • Как мне создать почтовый ящик?

  • Как мне поменять пароль?

  • Как мне удалить базу данных?

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

Хорошая документация самодостаточна

При написании документации в Plesk мы руководствуемся принципом «Every page is page one» (EPPO) почерпнутым из одноименной книги Марка Бейкера. Чтобы понять его суть, давайте подумаем о том, как люди читают печатные книги, и как ищут информацию в Интернете:

  • Человек, читающий печатную книгу, начинает чтение с первой страницы и читает последовательно, постепенно создавая контекст. В пятой главе нет нужды расшифровывать термин, с которым читатель познакомился во второй.

  • В случае с документацией в Интернете, любая страница может стать первой, так как пользователи приходят по ссылкам. Мы не можем контролировать то, где они окажутся, и мы не можем предполагать, что у них есть некий определенный контекст.

Таким образом, суть принципа EPPO можно выразить так: каждая страница документации в Интернете должна быть самодостаточной и содержать всю необходимую информацию или ссылки на нее.

Приведу пример. Некоторое время назад для того, чтобы защитить сайт SSL сертификатом, нужно было выполнить в панели Plesk следующие действия:

  1. Сгенерировать запрос на подпись сертификата (certificate signing request) и купить сертификат в центре сертификации (certificate authority).

  2. Загрузить полученный сертификат в хранилище.

  3. Выбрать загруженный сертификат в настройках веб сервера.

Номинально, каждый из приведенных выше пунктов можно рассматривать как отдельный сценарий, но подобный подход может ввести пользователя в заблуждение, так как для достижения цели (сайт защищен SSL сертификатом) нужно выполнить все вышеприведенные действия в правильной последовательности.

В согласии с принципом EPPO, нужно либо объединить все необходимые процедуры в один раздел, либо сделать несколько разделов, связав их ссылками. Например, в начале раздела, описывающего сценарий «загрузить полученный сертификат в хранилище в Plesk» нужно сослаться на раздел о сценарии «сгенерировать в Plesk запрос на подпись сертификата», а в конце — на раздел о том, как выбрать загруженный сертификат в настройках веб сервера. Благодаря этому, где бы посетитель ни оказался, он сможет сориентироваться, пройти сценарий от начала до конца и добиться желаемого результата.

Хорошая документация достоверна

Иными словами, она точно отражает то, как продукт выглядит и работает прямо сейчас, а не полгода назад. В наше время SaaS-продуктов, коротких релиз циклов и принудительных автоматических обновлений это правило, к сожалению, нарушается все чаще. Как ни странно, этим нередко грешит документация гигантов индустрии, таких как Microsoft или Google.

Думаю, не нужно объяснять, почему это вдвойне плохо, когда официальная документация содержит недостоверные сведения. Логотип компании на странице документации внушает уверенность, и посетитель тратит время попусту, пытаясь найти кнопку, которую убрали из интерфейса три релиза назад. Когда он понимает, что инструкции неверны, это действует как ушат холодной воды на голову и подрывает доверие и к документации, и к продукту, и к бренду. Единожды солгавший, кто тебе поверит?

Для того, чтобы подобного не происходило, команда технических писателей должна иметь следующее:  

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

  • Достаточно ресурсов, чтобы своевременно отражать эти изменения в документации.

  • Механизм сбора обратной связи, который позволит получать сигналы о тех неточностях, которые закрались в документацию несмотря на два предыдущих пункта. В Plesk мы получаем такую обратную связь от инженеров технической поддержки, а также от самих пользователей благодаря нашей форме обратной связи.

Хорошая документация пишется для определенной аудитории

Еще одно явление, о котором нужно знать, чтобы писать хорошую документацию — это «проклятие знания» (curse of knowledge). Под таким зловещим именем скрывается когнитивное искажение, заключающееся в том, что человеку информированному сложно встать на место человека неосведомленного и увидеть ситуацию его глазами. Если вы когда-нибудь произносили или думали про себя «Ну-у, да это все знают», вероятно, вы были под воздействием этого искажения.

К счастью, с этим искажением можно справиться. Достаточно помнить о нем и знать, кто целевая аудитория документации, которую вы пишете, и каким багажом знаний обладает ее среднестатистический представитель. Например, если вы документируете клиент Git, можно предположить, что представителю целевой аудитории не нужно рассказывать, что такое система управления версиями или как сделать коммит, но стоит задокументировать, как настроить доступ в репозиторий по SSH ключу. А если у вас в голове возникает мысль «Это, наверное, всем известно», напомните себе, что вы пишете документацию не для «всех», а для конкретной аудитории с конкретными знаниями и потребностями.

Проиллюстрирую этот пункт следующим примером: несколько лет назад я получил обратную связь от двух разных пользователей на один и тот же раздел. Она звучала примерно так:

  • Пользователь А: «Что вы пишете, как для дураков? Разжевываете вещи, которые любому известны!»

  • Пользователь Б: «Вы знаете, не каждый из нас гений. Пожалуйста, пишите яснее, мне ничего не понятно.»

Как вы думаете, кто из них был прав? На самом деле, правы оба. Судя по всему, раздел, на который они жаловались, как раз и был написан «для всех», но в итоге не смог сослужить службу никому. Он был слишком сложен для новичка, но не содержал подробностей, интересных эксперту. Как избежать подобных ситуаций? Знать, кто целевая аудитория, и писать с учетом ее потребностей. Ничего страшного, если вы получаете обратную связь только одного типа («слишком сложно» или «слишком просто») — это означает, что жалуются люди, не входящие в ЦА (конечно, если подобных обращений не десять штук за неделю).

Хорошая документация оказывает поддержку

Один из верных признаков плохой документации — она разжевывает очевидное, но не оказывает поддержки там, где это нужно. Не всегда достаточно просто перечислить шаги, которые необходимо пройти для достижения цели. Если в процессе того или иного сценария пользователю нужно сделать выбор, последствия которого не каждому могут быть очевидны, документация может и должна облегчить принятие решения, дав дополнительную информацию. Это называется «помощь в принятии решения» (decision support).

Приведу пример. В Plesk для защиты от спама используется программа под названием SpamAssassin. Одна из доступных пользователю настроек (spam filter sensitivity) управляет тем, насколько строго фильтр отсеивает входящие письма с подозрением на спам. Работает она просто: пользователь задает значение, выраженное положительным числом не больше 127. Чем меньше число, тем строже фильтр. Вот как могла бы быть описана эта настройка в «плохой» документации:

Введите желаемое число в поле «Spam filter sensitivity» и нажмите Ok.

Технически вышеприведенная инструкция верна, но практически от нее мало пользы. Пользователь, не знакомый с работой SpamAssassin, не знает, какое число он может ввести и как это повлияет на работу фильтра. Как можно было бы сделать лучше?

Введите желаемое число (больше 0 и не больше 127) в поле «Spam filter sensitivity» и нажмите Ok. Чем меньше число, тем меньше вероятность того, что в ваш ящик попадет спам, и тем больше вероятность ложного срабатывания, и наоборот.

А можно ли сделать еще лучше? Как насчет такого:

Введите желаемое число (больше 0 и не больше 127) в поле «Spam filter sensitivity» и нажмите Ok. Чем меньше число, тем меньше вероятность того, что в ваш ящик попадет спам, и тем больше вероятность ложного срабатывания, и наоборот. Рекомендуемое значение — 7, оно обеспечивает надежную защиты от спама с минимальной вероятностью ложного срабатывания и подойдет большинству пользователей.

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

Как еще можно облегчить жизнь пользователя? Не превращать его в Буриданова осла. Если продукт позволяет добиться того или иного результата несколькими путями, я не описываю их все. Я выбираю оптимальный (самый простой, самый быстрый и так далее) и рассказываю только о нем. Если же между этими путями есть разница (скажем, один быстрее, но подразумевает действия, требующие технических навыков или потенциально рискованные, например, выполнение запросов INSERT или UPDATE в базе данных), я описываю все варианты, эксплицитно указывая на различия между ними, чтобы помочь пользователю выбрать оптимальный для него вариант.

Ну и, конечно же, не забудьте предупредить пользователя в случае если его действия могут привести к неочевидным последствиям, особенно если они необратимы. Нет нужды писать о том, что удалить домен можно при помощи кнопки «Удалить домен». Это очевидно. Что не очевидно, так это то, что при удалении домена, например, будут автоматически удалены и все резервные копии, или что пользователь лишится доступа в панель, если его учетная запись заблокирована. «Налево пойдешь — коня потеряешь» куда полезнее и информативнее, чем просто «поворот налево».

Заключение

Теперь вы знаете, как писать хорошую документацию по версии Plesk. Прежде чем откланяться, я хотел бы рассказать еще об одном принципе, который я также позаимствовал у Марка Бейкера. Он звучит просто «Напиши одну хорошую страницу» («Write one good page»). Почему он кажется мне очень важным: если у вас уже есть массив документации, написанный по старинке и не соответствующий лучшим практикам, велик соблазн опустить руки. Переписать все с нуля — это целый подвиг! У нас нет столько времени и ресурсов! Но это не обязательно.

Наверняка среди вашей документации есть более посещаемые разделы и менее посещаемые (а если вы не знаете, сколько посетителей читает вашу документацию, то это отличный повод настроить веб аналитику). Переработайте ваш самый посещаемый раздел. Проследите за реакцией пользователей. Сделайте выводы, внесите коррективы, возьмитесь за второй по популярности раздел. И, возможно, пожимая вам руку, новый технический директор скажет «Документация? Это же очень важно! Загляну к вам в три часа, хочу узнать, как вы работаете».

Спасибо за внимание!

P.S. Хочу сказать «Спасибо!» моим коллегам Катерине Говердовской и Владимиру Головизнину за помощь в подготовке статьи.

Источник

Как писать автобиографию в военкомат? Правила и рекомендации

Правила такие:

  1. Хронологический порядок изложения событий – все, о чем вы хотите сообщить, должно излагаться последовательно, как это происходило в течение вашей жизни.
  2. Лаконичность изложения – в тексте следует отражать только важные и наиболее значимые события вашей жизни, без излишних подробностей и деталей, которые не несут смысловой нагрузки.
  3. Полнота информации – в идеале, автобиография должна содержать полную информацию о вас. При этом, под полнотой следует понимать ключевые характеристики личности, начиная с имени, даты и места рождения, образования, места работы, сведений о семье.
  4. Достоверность информации – все, о чем вы сообщаете, должно быть правдой. Неточности или искажение фактов не должны иметь место в документе. Конечно, о некоторых незначительных деталях (портящих вашу репутацию) можно и умолчать, но отраженная информация должна быть истинной.
  5. Изложение сведений о физических способностях, наличии заболеваний и травм. Необходимо отразить также свои спортивные достижения, а также наличие (отсутствие) хирургических операций, тяжелых травм, длительного нахождения на лечении.
  6. Общий объем вашей автобиографии не должен превышать 2 страниц печатного или рукописного текста.
  7. Важно, чтобы изложение было грамотным. А если автобиография составляется от руки – чтобы почерк был аккуратным и разборчивым. 

Как пишется автобиография для военкомата – образец

Воспользуйтесь образцом автобиографии в военкомат, приведенным ниже: 

 «Я, Сергеев Александр Васильевич, родился 01.01.____ г. в городе Хабаровске, Хабаровского края.

Отец: Сергеев Василий Александрович, родился __ __ ____ году, уроженец города Хабаровска. Проживает по адресу: г. Хабаровск, ул. Ленина, д. 1, кв. 25. Образование высшее юридическое. С ____ года по настоящее время состоит на службе в вооруженных силах, на сегодняшний день имеет звание полковника.

Мать: Сергеева Елена Владимировна, родилась __ __ ____ года, уроженка города Хабаровска. Проживает по адресу: г. Хабаровск, ул. Ленина, д. 1, кв. 25. Образование среднее специальное, повар. Не работает.

Брат: Сергеев Денис Васильевич, родился __ __ ____ года, уроженец города Хабаровска. Проживает по адресу: г. Хабаровск, ул. Ленина, д. 1, кв. 25. На сегодняшний день обучается в общеобразовательной школе № 12. 

В ____ году я пошел в общеобразовательную школу № 12, которую закончил в ____ году. За период обучения неоднократно участвовал в разнообразных олимпиадах, в некоторых из них занимал призовые места:

– общегородская Олимпиада по русскому языку (____ год) – 1 место;

– краевая Олимпиада по математике (____ год) – 2 место.

С ____ года занимаюсь боксом. За период с ____ по ____ год принял участие в 10 краевых и 2 общероссийских соревнованиях, на которых завоевывал медали следующего достоинства:

– краевые соревнования ____ – золото;

– краевые соревнования ____ – золото;

– общероссийские соревнования ____ – бронза.

В ходе общероссийских соревнований ____ года, в которых я принимал участие, получил травму головы (сотрясение мозга), в результате чего выбыл из соревнований. Проходил лечение в городской больнице № 10 с __ __ ____ года по __ __ ____ года. После прохождения лечения и реабилитационных мероприятий ограничений по здоровью не имею, на учете в медицинских учреждениях не состою.

После окончания школы обучался в автошколе, получил водительское удостоверение категории «В», после чего поступил в профессиональное училище № 2 по специальности автослесарь. __ __ ____ года закончил указанное учебное заведение.

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

Вредных привычек не имею, приводов в полицию не было, на учете не состоял, не женат, детей нет».

Автобиография в военкомат для контрактников

Для контрактников предусмотрена своя форма автобиографии в военкомат (утверждена Приказом Министра обороны РФ от 07.07.2020 № 310, можно скачать в разделе «Документы и бланки» в начале статьи).

Вам понадобится заполнить анкету, ответив на поставленные в ней вопросы. 

В частности, нужно указать: 

  • Ф.И.О.
  • Дату рождения.
  • Паспортные данные.
  • Сведения о семейном положении.
  • Данные о гражданстве.
  • Ваш уровень образования.
  • Данные о том, оформлялся ли на вас доступ к гос. тайне. 
  • Сведения о том, ходатайствовали ли вы о выезде на постоянное проживание в другое государство. 
  • Были ли вы за границей.
  • Судимы ли вы.
  • Ваше отношение к воинской обязанности.
  • Данные о вашем предыдущем трудоустройстве.
  • Сведения о ваших близких родственниках.

Еще несколько советов

Следует сказать, что приведен лишь примерный образец автобиографии в военкомат. Это не означает, что в вашей автобиографии будут все те моменты, которые мы отразили. Вполне возможно, что в вашем случае данный образец автобиографии в военкомат необходимо будет дополнить данными о пройденном обучении, об имеющихся навыках, достижениях.

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

Если есть взрослые братья и сестры – указать их образование, место жительства и место работы. Важно также отразить факт наличия у вас на иждивении детей, родственников или иных лиц (если такой факт имеет место).

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

Еще больше материалов по теме в рубрике: «Военкомат». 

Источник

Когда речь заходит о прокачке писательских навыков, есть стандартный набор профессиональных советов. Как правило, они — про глубокое погружение, системную работу и небыстрый результат.

Мы собрали простые (и гениальные) приемы семи культовых писателей — они помогут перенастроиться и начать писать лучше уже сейчас. 

Харуки Мураками

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

1. Старайся никого не обидеть. Пиши так, чтобы не оскорбить чувств читателей. Эмпатия в тексте работает лучше, чем обвинения или осуждение. «Что бы ты ни написал, есть вероятность, что кто-то получит травму или расстроится. Поэтому я изо всех сил стараюсь написать то, что никому не повредит», — говорит Мураками.

2. Отправь читателя в путешествие. Рассказ должен увлекать читателя так, чтобы тот мог полностью в него погрузиться. Добавь в свой текст деталей, которые помогут ощутить себя в месте, где разворачивается действие. 

Этот прием использовали в ролике Mitsubishi All New L200 Triton Sport 2017: там автомобиль проносится через средневековое поле боя. Картинка увлекает так, что кажется не рекламой, а скорее трейлером к захватывающему фильму:

3. Пиши, чтобы порадовать и утешить. Читатель запоминает не текст, а эмоции, которые пережил. Радостные хочется вспоминать чаще, тревожные — быстрее забыть, поэтому в своих книгах Мураками играет на поле светлых и сентиментальных чувств.

Задача рекламы — вызвать эмоцию. Именно на этом Coca-Cola выстраивает нарратив в ролике The Great Meal. Он стал частью первой кампании бренда с начала пандемии. История показывает семьи, которые хоть и застряли вместе в период локдауна, но все равно могут найти что-то хорошее в изоляции: они готовят любимые блюда:

Стивен Кинг

Кинг — мастер держать читателя в напряжении и очень продуктивный писатель: он опубликовал уже 60 романов, его произведения экранизировали более 100 раз. В своей работе он руководствуется такими принципами: 

1. Будь готов к критике. Когда Кинг начинал свою карьеру, на стене в его комнате был вбит гвоздь, на который он крепил письма с отказами от издательств. Чем популярнее становились его книги — тем больше негативных отзывов он слышал.

Если ты пишешь — будь готов к тому, что твою работу будут обсуждать. Часто в гораздо более жестком ключе, чем она того заслуживает.

Такой масштабной критике подверглась кампания Nike — Dream Crazy. В ролике снялся футболист Колин Каперник, который во время исполнения национального гимна встал на одно колено (а не остался стоять, как другие) в знак протеста против расовой дискриминации в США. Реклама привела к скандалу, из-за которого многие начали сжигать кроссовки Nike, — но настоящие фанаты бренда, наоборот, поддержали его.

 2. Пиши в первую очередь для себя. Писать нужно только тогда, когда не можешь этого не делать. Это занятие должно драйвить и наполнять. Если ты пишешь через силу — это чувствуется в тексте. Как говорит Кинг: «Я пишу, потому что мне это нравится. И если ты можешь делать это потому, что тебе нравится, — то сможешь делать это вечно».  

3. Используй свой словарь. Писать нужно так, как говоришь — простым языком, живыми фразами. Например, вместо «меня это впечатлило» герой скажет «я просто обалдел». А подруга вместо «кажется, ты перестаралась» прокомментирует «чего ты вырядилась как на свадьбу?».

На живой разговорной речи агентство Banda построило рекламную кампанию попкорна Pumpidup со слоганом «Попкорн, який всюди норм». Например, в ролике вместо «встретиться» звучит «пересечься», а вместо «велосипед» — «велик»:

Чарльз Буковски

Журнал Time назвал Буковски «лауреатом американской дурной жизни». Он стал известным только к 46 годам, а до этого жил бедно, пил много и писал об этом честно.

Вот три совета от писателя-бунтаря:

1. Не надоедай читателю. Текст должен вести человека за действием и не отвлекать лишними лирическими отступлениями. Буковски считал, что именно динамика нарратива заставляет читателя переворачивать страницы и двигаться дальше. К героям Буковски бывает сложно проникнуться как раз потому, что читатель не успевает понять их чувств — зато текст всегда дочитывает до конца.  

2. Пиши честно. «У меня была дрянная жизнь, вот и все. Дерьмовая жизнь, о которой можно писать», — говорил Буковски. Он пережил буллинг в школе, нищету, одиночество и алкоголизм. В своих произведениях он рассказывал о том, что переживал. Ты не сможешь хорошо описать вещи, о которых не знаешь. Лучшие истории — те, в которых у тебя есть личный опыт.

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

Отказываться от редактуры мы не советуем (если ты не бунтарь), но зацикливаться и дорабатывать произведение из чистого перфекционизма — не нужно. 

Чак Паланик

Чак Паланик начал свою писательскую карьеру с журналистики. Оттуда же он вынес свой стиль: лаконичный, динамичный — минимум описаний, максимум действия. Вот три совета по писательству от автора «Бойцовского клуба»:

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

Пояснения должны дать человеку возможность подумать: «да-да, я когда-то об этом слышал» — и почувствовать себя умным.

2. Не называй эмоции — создавай ситуацию, которая их опишет. Описание эмоции не вызывает эмоций, поэтому наречия вроде «грустно», «весело» и «впечатляюще» вычеркивай из текста сразу.

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

3. Описывай все так, как видит персонаж. Не используй абстрактные измерения: читателю трудно представить, как выглядит расстояние в 17 метров, но вот ширина дороги в 6 полос — вполне наглядное описание.

Разворачивай картинку так, как ее видит герой. Так ты не только разнообразишь текст емкими сравнениями, но и раскроешь характер персонажа, от имени которого ведешь рассказ. Например, вместо «на улице стало холодно» напиши «она сжала ладони в кулаки и спрятала их в рукавах свитера».

Этот прием использовали HP в ролике 3D Scanning Made Easy, снятом от первого лица. В рекламе сканера объемных объектов не говорят о его технических характеристиках, а показывают процесс работы с гаджетом с точки зрения дизайнера:

 Эрнест Хемингуэй

«Краткий» — самое точное слово, чтобы описать стиль Хемингуэя. Такому емкому, драматичному и динамичному письму можно научиться. Вот три главных писательских совета от «старика Хэма»:

1. Пиши о том, что знаешь. Хемингуэй использовал реальных людей и события в качестве материала для своих рассказов. Он считал, что именно это заставляет его истории оживать: персонажи выходят объемными, а история — правдоподобной.

2. Короткие предложения. У Хемингуэя все работы написаны так, чтобы читать было легко. 

Даже одного длинного запутанного предложения достаточно, чтобы читатель потерял интерес. Вместо того чтобы перечитывать, большинство бегло просмотрят абзац — и двинутся дальше. Но если перегружен будет весь текст, человек может вообще сдаться и не дочитать его.

Метод коротких предложений хорошо использовать в роликах, где текст — это основной фокус, а картинка — только его иллюстрация, как в бренд-манифестах.  

Этот прием использует H&M в одном из своих роликов об «устойчивой» моде. Бренд перечисляет фэшн-стереотипы, чтобы сказать, что в моде нет правил, кроме одного — сдавать одежду на переработку.

3. Существительные и глаголы вместо прилагательных и наречий. Долгие описания и абстрактные характеристики захламляют текст, при этом не добавляя ему смысла. Чтобы нарратив был динамичным, избегай детальных и громоздких описаний.

Антон Чехов

Чехов написал более 300 произведений, стал мастером краткой формы и создал «метод ружья» — принцип, по которому все детали рассказа должны иметь значение. «Нельзя ставить на сцене заряженное ружье, если никто не имеет в виду выстрелить из него», — считал Чехов.

Вот три совета по писательству от автора, который стал одной из главных фигур в мастерстве драматургии:

1. Жалей своих персонажей. Чтобы вызывать эмпатию, читателю должно быть легко ассоциировать персонажей с собой. А узнать себя в идеальных людях довольно сложно. Оставь маленький скол на личности персонажа — покажи его слабости и не осуждай их в тексте, а оправдывай.

Это же важно и для создания рекламы. Например, ролик приложения для здоровья и фитнеса BetterMe поддерживает героиню и в хорошие, и в плохие дни. История построена на том, что девушка выходит замуж за саму себя, чтобы «принимать себя и в горе и в радости».

2. Не создавай однозначно положительных или отрицатель­ных персонажей. Противопоставление чистого зла добру делает историю плоской. Чтобы оживить рассказ, доверь прогрессивные идеи неприятным героям — и наоборот. Например, непрактичный, но симпатичный худож­ник или идейная, трудолюбивая, но жестокая по отношению к родным девушка.

Этот подход выбрала общественная организация Donate Life. Она призывает подключиться к программе донорства органов в случае смерти через абсолютно неприятного персонажа:

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

Например, в рассказе Чехова «Разговор человека с собакой» пьяный персонаж ведет беседы с овчаркой, и это комично. В рассказе «Тоска» герой тоже говорит с животным — лошадью, но это уже драма: у старика-извозчика умер сын, и ему не с кем разделить свое горе.

Если «Разговору человека с собакой» добавить контекст или развитие событий — почему герой стал пить и что с ним случилось потом — история из смешной превратится в трагичную.

Генри Миллер

Автор «Тропика Рака» сформулировал свои профессиональные советы в 11 лаконичных заповедях писателя. Мы выбрали из них те три, которые помогают посмотреть на работу над текстами под другим углом.

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

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

На нестандартном формате наружной рекламы строятся кампании бренда растительного молока Oatly — они размещают на бордах много текста, шутят с аудиторией и почти не говорят о свойствах продукта.

Чтобы не происходило как пишется

3. Встречайся с людьми, ходи куда-нибудь, пей, если хочешь. Нельзя загнать себя в четыре стены, отключить интернет и ждать результата. Выгорание — спутник творческих людей, и «выжать» из себя хороший текст силой просто невозможно. Кроме того, писателю нужен материал. А его сложно найти в пределах рабочего места. 

Источник

Я живу в Ташкенте, и когда учился в университете — начал учить Python, чтобы писать ботов. Боты — это узбекский хлеб, у нас на них построено вообще все. Например, никто не делает приложения для заказа еды, все только в мессенджерах. 

Я учил язык по статьям из интернета — просто брал каркас и дальше дописывал, смотрел, где что падает, постоянно решал задачи на leetcode. Писал я тогда ужасно, но что было, то было. Мне нравилось, но чем больше я углублялся, тем сильнее раздражали скорость выполнения, ограничения параллелизма и динамическая типизация.

Тогда я решил попробовать Go.

Go — простой, классный и востребованный 

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

Возможно, Go не такой выразительный, возможно, там есть спорные решения — например, пустые интерфейсы, которые клали на всю вашу типизацию, или пакет рефлект, в который лучше не заглядывать. Но в целом, обычный продакшн код на Go и правда читабелен, это один из немногих языков, где ты можешь нырнуть почти в любую библиотеку и понять, что там происходит хотя бы на механическом уровне без погружения в доменную область.

Как говорил Роб Пайк: «Простота — это сложно». Философия, все дела. Кто-то ругает голанг за излишнюю простоту, а мне она нравится.

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

Один раз я полуслучайно угодил на синьорское собеседование. Это было самое душное из всех интервью, что я видел. Было ощущение, что интервьюера заставили прийти и слушать меня. Он сразу начал с технических вопросов, и я понял, что он просто задает вопросы из статьи с хабра — причем идет по ним подряд, как будто за 15 минут до встречи погуглил «Вопросы для собеседования бэкенд-разработчика».

Эйчары написали мне через месяц и сказали, что уже готовят оффер. Потом написали еще через час и сказали, что, к сожалению, иностранцев они уже не берут.

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

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

Популярные задачи на собеседованиях

На вход подаются два неупорядоченных слайса любой длины. Надо написать функцию, которая возвращает их пересечение

Стандартная задача с leetcode и ее довольно часто спрашивают на собеседованиях в качестве простой задачи для разогрева. 

Можно решить сортировкой, за более долгое время, но без выделения дополнительной памяти. А можно выделить дополнительную память и решить за линейное время.

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

Решение

package main

import (
	"fmt"
)

// На вход подаются два неупорядоченных массива любой длины.
// Необходимо написать функцию, которая возвращает пересечение массивов
func intersection(a, b []int) []int {
	counter := make(map[int]int)
	var result []int

	for _, elem := range a {
		if _, ok := counter[elem]; !ok {
			counter[elem] = 1
		} else {
			counter[elem] += 1
		}
	}
	for _, elem := range b {
		if count, ok := counter[elem]; ok && count > 0 {
			counter[elem] -= 1	
			result = append(result, elem)
		}
	}
	return result
}

func main() {

	a := []int{23, 3, 1, 2}
	b := []int{6, 2, 4, 23}
	// [2, 23]
	fmt.Printf("%vn", intersection(a, b))
	a = []int{1, 1, 1}
	b = []int{1, 1, 1, 1}
	// [1, 1, 1]
	fmt.Printf("%vn", intersection(a, b))
}

Написать генератор случайных чисел

В принципе, легкая задача, на базовые знания по асинхронному взаимодействию в Go. Для решения я бы использовал небуфферезированный канал. Будем асинхронно писать туда случайные числа и закроем его, когда закончим писать.

Плюс ее можно использовать в немного измененном виде в задаче на слияние N каналов.

Решение

package main

import (
	"fmt"
	"math/rand"
	"time"
)

func randNumsGenerator(n int) <-chan int {
	r := rand.New(rand.NewSource(time.Now().UnixNano()))

	out := make(chan int)
	go func() {
		for i := 0; i < n; i++ {
			out <- r.Intn(n)
		}
		close(out)
	}()
	return out
}

func main() {
	for num := range randNumsGenerator(10) {
		fmt.Println(num)
	}
}

Слить N каналов в один

Даны n каналов типа chan int. Надо написать функцию, которая смерджит все данные из этих каналов в один и вернет его.

Мы хотим, чтобы результат работы функции выглядел примерно так:

for num := range joinChannels(a, b, c) {

       fmt.Println(num)

}

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

Создаем канал, куда будем сливать все данные. Он будет небуферезированный, потому что мы не знаем, сколько данных придет из каналов.

Дальше асинхронно прочитаем из исходных каналов и закроем результирующий канал для мерджа, когда все чтение закончится. Чтобы дождаться конца чтения, просто обернем этот цикл по каналам в wait group. 

Решение 

package main

import (
	"fmt"
	"sync"
)

func joinChannels(chs ...<-chan int) <-chan int {
	mergedCh := make(chan int)

	go func() {
		wg := &sync.WaitGroup{}

		wg.Add(len(chs))

		for _, ch := range chs {
			go func(ch <-chan int, wg *sync.WaitGroup) {
				defer wg.Done()
				for id := range ch {
					mergedCh <- id
				}
			}(ch, wg)
		}

		wg.Wait()
		close(mergedCh)
	}()

	return mergedCh
}

func main() {

	a := make(chan int)
	b := make(chan int)
	c := make(chan int)

	go func() {
		for _, num := range []int{1, 2, 3} {
			a <- num
		}
		close(a)
	}()

	go func() {
		for _, num := range []int{20, 10, 30} {
			b <- num
		}
		close(b)
	}()

	go func() {
		for _, num := range []int{300, 200, 100} {
			c <- num
		}
		close(c)
	}()

	for num := range joinChannels(a, b, c) {
		fmt.Println(num)
	}

}

Сделать конвейер чисел

Даны два канала. В первый пишутся числа. Нужно, чтобы числа читались из первого по мере поступления, что-то с ними происходило (допустим, возводились в квадрат) и результат записывался во второй канал. 

Довольно частая задача, более подробно можно почитать тут https://blog.golang.org/pipelines.

Решается довольно прямолинейно — запускаем две горутины. В одной пишем в первый канал. Во второй читаем из первого канала и пишем во второй. Главное — не забыть закрыть каналы, чтобы ничего нигде не заблокировалось.

Решение 

package main

import (
	"fmt"
)

func main() {
	naturals := make(chan int)
	squares := make(chan int)

	go func() {
		for x := 0; x <= 10; x++ {
			naturals <- x
		}
		close(naturals)
	}()

	go func() {
		for x := range naturals {
			squares <- x * x
		}
		close(squares)
	}()

	for x := range squares {
		fmt.Println(x)
	}
}

Написать WorkerPool с заданной функцией

Довольно распространенная задача, плюс подобные задачи встречаются на практике. 

Нам нужно разбить процессы на несколько горутин — при этом не создавать новую горутину каждый раз, а просто переиспользовать уже имеющиеся. Для этого создадим канал с джобами и результирующий канал. Для каждого воркера создадим горутину, который будет ждать новую джобу, применять к ней заданную функцию и пулять ответ в результирующий канал.

Решение 

package main

import (
	"fmt"
)

func worker(id int, f func(int) int, jobs <-chan int, results chan<- int) {
    for j := range jobs {
        results <- f(j)
    }
}

func main() {

    const numJobs = 5
    jobs := make(chan int, numJobs)
    results := make(chan int, numJobs)

    multiplier := func(x int) int {
	return x * 10
    }

    for w := 1; w <= 3; w++ {
        go worker(w,  multiplier, jobs, results)
    }

    for j := 1; j <= numJobs; j++ {
        jobs <- j
    }
    close(jobs)

    for i := 1; i <= numJobs; i++ {
        fmt.Println(<-results)
    }
}

Сделать кастомную waitGroup на семафоре

Семафор можно легко получить из канала. Чтоб не аллоцировать лишние данные, будем складывать туда пустые структуры.

В нашем случае мы хотим сделать семафор, который будет ждать выполнения пяти горутин. Для этого просто добавим вместо обычного канала буфферизированный. И внутри каждой горутины положим в него значение. А в конце будем дожидаться, что все ок — мы вычитаем все значения из канала. 

Решение 

package main

import (
	"fmt"
)

type sema chan struct{}

func New(n int) sema {
	return make(sema, n)
}

func (s sema) Inc(k int) {
	for i := 0; i < k; i++ {
		s <- struct{}{}
	}
}

func (s sema) Dec(k int) {
	for i := 0; i < k; i++ {
		<-s
	}
}

func main() {
	numbers := []int{1, 2, 3, 4, 5}
	n := len(numbers)

	sem := New(n)

	for _, num := range numbers {
		go func(n int) {
			fmt.Println(n)
			sem.Inc(1)
		}(num)
	}

	sem.Dec(n)

}

В общем, если понравились задачи и показались полезными — заходите в канал Rebrain — там часто выкладывают бесплатные вебинары и практикумы по Go. Потом можно обсуждать кто, что и как делает в сообществе.

Мысли о будущем Go

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

Никто не ругает топор, за то что он такой топорный, да и вообще он не бензопила. 

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

Но сейчас на Go все чаще пишут гигантские системы. Наделали фреймворков (само по себе понятие «фреймворк» — противоречит идее Go), разработали инструменты, чтобы затащить его на фронтенды, адаптировать к разработке огромных приложений, стали делать на нем все, что не приколочено. Начали требовать серьезного развития языка в сторону усложнения — чтобы было как в Java и C#. Чтобы у нас, значит, тоже получалось пилить грандиозные монолитные бэкенды, обмазывать всё тоннами декораторов, писать универсальный, сверхпереиспользуемый код и все такое.

Посмотрите на С++. Чтобы угодить потребностям всех разработчиков на плюсах, язык набили фичами настолько, что всерьез вот сесть и выучить С++ невозможно. А уж выбрать его в качестве инструмента для разработки, когда есть альтернативы — абсолютно исключено.

Go стал очень популярным. Мой прогноз — через несколько лет они напичкают его всеми концепциями, которыми только смогут, и будут писать на нем все возможные виды софта. И тогда где-то какой-то парень возьмет, и снова изобретет новый простой инструмент для простых задач.

Автор статьи — @alisher_m, участник сообщества Rebrain. Подписывайтесь, если хотите тоже поделиться опытом и поспрашивать советов. Там регулярно разбираем все эти темы и многие другие, которые пригодятся и на собеседовании, и в работе.

Источник

Принципы

Текст, как любой контрол, должен выполнять полезное действие

Текст — элемент интерфейса, как кнопка или поле ввода. Он помогает решить интерфейсную задачу: объясняет непонятное и убеждает выполнить нужное действие. В интерфейсе ни одно предложение не появляется просто так. Уберите текст, если он не выполняет работу.

Пишите кратко

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

Пишите просто

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

Пишите убедительно

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

Информационный стиль текста

Мы стараемся поддерживать единый стиль общения с клиентами, и написали для этого большую статью про редполитику.

Синтаксис

Синтаксис — это раздел грамматики о составе предложения и порядке слов в предложении. Писать просто — значит писать так, чтобы синтаксис был простым.

Подлежащее и сказуемое стоят рядом

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

Неправильно

Сюрприз для всех, кто жаждет обрести этой зимой внутреннее равновесие, красоту и здоровье, ждет в конце письма.

Правильно

В конце письма всех ждет сюрприз. Он поможет обрести внутреннее равновесие, красоту и здоровье этой зимой.

Перенесите главное в начало предложения

Перенесите то, что хотели сказать, в начало предложения. Это поможет распутать сложную мысль.

Неправильно

На основе вашего ИНН мы нашли в базе ЕГРЮЛ и загрузили в Контур.Экстерн такие реквизиты:

Правильно

Контур.Экстерн заполнил реквизиты организации на основе данных из ЕГРЮЛ

Неправильно

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

Правильно

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

Неправильно

Совместно с коллегами, отвечающими за те или иные направления обустройства нового офиса, мы обобщили вопросы, которые вызывают беспокойство, и ниже приводим их обзор.

Правильно

Мы обобщили вопросы, которые беспокоят контуровцев больше всего.

Замените модальные глаголы на нормальные

Модальный глагол — слабый глагол, смысл которого раскрывается следующим за ним словом. Чтобы избавиться от модальности, возьмите отглагольное существительное, которое идет за ним, и образуйте от него глагол.

Неправильно

Осуществляет продажу

Одержал победу

Правильно

Продает

Победил

Текст с нормальными глаголами получается короче и звучит увереннее. Иногда модальным глаголам сложно найти замену, например, «был», «есть» и «будет» можно оставить в тексте.

Не используйте пассивный залог

Пассивный залог образуется, когда мы теряем подлежащее и оставляем сказуемое. Действие есть, а действующего лица нет. Чтобы избавиться от пассивного залога, добавьте в текст лицо, которое совершает действие. Спросите себя, кто что сделал.

Неправильно

В Блогове был опубликован пост

Вам будет отправлено письмо со ссылкой для входа.

Ошибки, которые были допущены в планировании итерации, сказались на сроках реализации проекта.

Правильно

Вася опубликовал пост в Блогове

Контур.Фокус отправит письмо со ссылкой для входа.

Мы ошиблись при планировании итерации и продолбали сроки.

Что почитать по теме:

«Как уйти от безличного повествования»

«Если действующие лица неизвестны»

Не используйте текст в скобках

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

Правильно

Страдательный (пассивный) залог

Добавьте филиал (обособленное подразделение) организации

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

Неправильно

Обрпрограммы проводят образовательные мероприятия (стажировки, летние и онлайн-курсы) для студентов.

Правильно

Обрпрограммы проводят стажировки, летние и онлайн-курсы для студентов.

Если текст в скобках хуже раскрывает мысль, уберите его:

Неправильно

Обрпрограммы проводят стажировки, летние и онлайн-курсы (и др. образовательные мероприятия) для студентов.

Правильно

Обрпрограммы проводят стажировки, летние и онлайн-курсы для студентов.

Если текст в скобках — самостоятельная мысль, выделите ее в отдельное предложение:

Неправильно

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

Правильно

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

Точка с запятой в предложении — признак слишком сложного синтаксиса

Замените причастие на нормальный глагол

Причастие — это глагол с признаками прилагательного, оно сложнее и слабее обычного глагола. Кроме того, причастие не стоит само по себе, а образует причастный оборот и этим усложняет синтаксис.

Неправильно

Статья, разъясняющая нюансы заполнения новой налоговой формы…

Правильно

В статье автор разъясняет нюансы заполнения новой налоговой формы…

Заменили причастие на нормальный глагол, сразу и действующее лицо появилось.

Неправильно

СКБ Контур — компания, разрабатывающая веб-сервисы для бизнеса.

Правильно

СКБ Контур разрабатывает веб-сервисы для бизнеса.

Что почитать по теме

«Отглагольное»

«Вложенные и причастные обороты»

Замените деепричастие на нормальный глагол

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

Неправильно

Проанализировав новый закон, мы пришли к выводу…

Правильно

Мы проанализировали новый закон и пришли к выводу…

Что почитать по теме:

«Отглагольное»

«Вложенные и причастные обороты»

Не ставьте в предложение больше трех однородных членов подряд и больше двух рядов однородных членов

После третьего однородного члена читатель перестает их запоминать. Три ряда по три однородных члена в каждом так же плохо, как один ряд с пятью-шестью однородными членами.

Неправильно

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

Используйте три однородных члена, чтобы сделать высказывание убедительным.

Правильно

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

Один однородный член&nbsp отсутствие однородных членов помогает автору выделить главное, а читателю — понять, о чем сейчас пойдет речь.

Правильно

Бухгалтеры любят Контур.Бухгалтерию за простоту использования.

Что почитать по теме:

«Однородные члены»

«Как сокращать однородные члены»

«Вложенные однородные члены»

Вереницы существительных в родительном падеже запрещены

«Друг подруги тёлки брата» — это сложно для понимания. Попробуйте «размотать» эту цепочку. Упростите или разделите на два предложения.

Неправильно

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

Правильно

Контур.Гайды — первоисточник требований к элементам интерфейса. Эти требования распространяются на внутренние и внешние веб-сервисы Контура.

Эмоции

Эмоции в интерфейсе уместны вне проблемных ситуаций, рутинных или критических действий и элементов управления

Милые картинки и шутки в тексте вызывают положительные эмоции у пользователя. Но пользователю не до шуток, если он столкнулся с проблемой, которая не дает ему выполнить сценарий. Если сервис недоступен или у пользователя неподходящий браузер, нужно помочь ему, а не развлечь.

Подключайте эмоции при редких и радостных событиях:

  • Пользователь сдал всю отчетность,
  • Завершил миграцию в ваш сервис,
  • Не получил за год ни одного требования.

Полезно и правильно отмечать достижения пользователя, пытаться развлечь его в момент триумфа.

Набор капсом запрещен

Слова, набранные заглавными буквами, означают крик в речи, а мы не кричим на пользователей.

Старайтесь не использовать восклицательный знак

Вежливость

В веб-сервисах формы вежливости редко бывают уместны и еще реже нужны.

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

Здравствуйте

Здороваться обязательно в маркетинговых и новостных рассылках и запрещено в «технических» письмах.

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

Пожалуйста

Не просите пользователя сделать что-то через «пожалуйста». Лучше объясните пользу.

Неправильно

Пожалуйста, заполните карточку сотрудника.

Правильно

Такого сотрудника нет. Добавьте его, чтобы начислить зарплату.

Извините

Извиняться нужно, если проблема произошла по нашей вине. Если проблема возникла не по нашей вине, извиняться нельзя.

При ошибке 500 мы подводим пользователя — он не смог воспользоваться сервисом, когда это было нужно. В этом случае извиниться в сообщении обязательно.

Правильно

Извините, сервис недоступен. Мы знаем о проблеме и уже занимаемся ей.

Когда пользователь загрузит некорректный XML-файл отчета или фотографию вместо xml-файла, мы покажем ошибку без «извините». В таких случаях нужно просто сообщить о проблеме.

Правильно

Это не отчет. Выберите другой файл.

Объявления и сообщения об ошибках

Если сообщение укладывается в одно—два простых предложения, заголовок не нужен

Часто в таких случаях добавляют бесполезный заголовок, чтобы был: «Уважаемые пользователи», «Важное объявление», «Внимание!» или «Убедительная просьба!». Последние два — признак сообщения, до которого никому нет дела.

Не тратьте внимание пользователя на ерунду, переходите сразу к делу.

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

Чтобы дойти до сути этого сообщения, придется дочитать до конца:

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

Если цель — не подписать как можно больше пользователей, а просто сообщить об изменениях, подходящий заголовок может быть таким:

Если вы видите, что заголовок получается слишком частным, а тема гораздо шире, то обобщите: «Изменился порядок ответа на требование». Так тоже можно, но только не «Уважаемые пользователи» и не «Вниманию налогоплательщиков». Налоговые инспекторы так могут писать, а мы — нет.

В веб-сервисах обращение к аудитории в заголовке бессмысленно. Заголовок «Уважаемые …» уместен, когда объявление нацелено на одно подмножество людей из всех, кто его увидит. Так бывает редко. Например, вы вешаете в коридоре объявление для дизайнеров Контура и хотите, чтобы его читали только дизайнеры. Или вы ищете программиста в своей проект — тогда заголовок «Программисты, есть работа!» будет к месту.

Когда в веб-сервисе пишут «Уважаемые пользователи», а в подъезде «Уважаемые жильцы и гости» — заголовок не выполняет работу, потому что кроме них не к кому обращаться.

Если произошла ошибка, напишите, что произошло, с точки зрения пользователя, а не с точки зрения системы

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

Неправильно

Произошла ошибка: На сервере anyservice.kontur.ru учетная запись не найдена.

Правильно

Мы не нашли такую организацию.

Заголовки сообщений об ошибках должны различаться

Это удобно пользователю и консультанту. Консультант техподдержки сможет по одному заголовку определить проблему. А пользователь при повторных ошибках сможет с первого предложения понять, что произошло и что делать дальше, не дочитывая сообщения до конца. Когда «Произошла неизвестная ошибка» — трудно будет всем.

Чтобы пользователь предотвратил проблему в следующий раз, обучите его

Расскажите пользователю, что делать, чтобы ошибка не возникала в будущем. Делайте это в последнюю очередь. Сначала пишем «что произошло», потом «как исправить» и только потом «что делать, чтобы такое не происходило».

Орфография и пунктуация

В правилах орфографии и пунктуации дизайнеры руководствуются

этим гайдом,

справочником Лопатина,

справочником Мильчина и Чельцовой.

В заголовках точки ставятся только между предложениями и не ставятся, если предложение одно

Знак вопроса в заголовке не ставится, если в заголовке стоит вопросительное слово, и ставится несмотря на вопросительное слово, если автор статьи задает вопрос читателям

Правильно

Как заполнить налоговую декларацию по НДС

Что нового в правилах заполнения табеля

Как вам новый расчет больничных?

Заголовок не может заканчиваться двоеточием

Даже если это заголовок списка и после него идет ряд однородных членов, двоеточие все равно не нужно.

Правильные кавычки — «кавычки-елочки» для первого уровня и „кавычки-лапки“ для второго уровня

В хинтах и тултипах точка ставится только между предложениями и не ставится, если предложение одно

Хинты и тултипы описывают назначение или работу элемента интерфейса. Они поясняют и подобны подписи к картинке. Поэтому к ним применяется правило подписи к картинке.

Буква «ё» используется только там, где возможно разночтение и из контекста не понятно, какое слово подразумевалось

все — всё

узнает — узнаёт

Малоизвестные имена собственные с буквой «ё»

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

В веб-сервисах, на промосайтах, в почтовых рассылках и рекламных материалах «вы» пишется со строчной буквы

По правилам русского языка обращение на «вы» к единственному человеку — само по себе форма уважения. «Вы» с заглавной (большой) буквы уместно в личной и деловой переписке с человеком, которого вы очень уважаете. Например, вы мужчина и пишете даме сердца, или вы организатор конференции и приглашаете выступить мировое светило веб-разработки.

Веб-сервисы, промосайты, почтовые рассылки и рекламные материалы не относятся ни к личной, ни к деловой переписке. «Вы» в них — мерзкое заискивание, подобострастие и канцеляризм. Это — признаки фальши, а фальшь снижает доверие к тексту.

Мы уважаем наших пользователей и русский язык, поэтому пишем «вы». Если вам нужен ультраавторитетный источник, знайте, Д. Э. Розенталь на нашей стороне.

Слова «компания», «клиент» и остальные формы обращения пишутся со строчной, если это не первое слово в предложении

Вместо слов «функционал» и «функциональность» используйте менее сленговое слово «возможность». Еще лучше — сразу написать о том, что сервис научился делать

Неправильно

Появилась функциональность по расчету зарплаты для сотрудников с вредными условиями труда.

Появилась возможность считать зарплату сотрудникам с вредными условиями труда.

Правильно

Теперь Контур.Бухгалтерия считает зарплату сотрудникам с вредными условиями труда.

Имена собственные

Название «Контур» и названия продуктов склоняются. Не склоняется только «СКБ Контур»

Названия продуктов склоняются хоть со словом «контур», хоть без него.

Правильно

В Контур.Нормативе найдутся любые законы

В Нормативе найдутся любые законы

«СКБ Контур» не склоняется потому, что в названии компании присутствует аббревиатура. Зато можно просклонять родовое слово перед ним.

Неправильно

в СКБ Контуре

Правильно

в компании «СКБ Контур»

«Рыба» в прототипах

Пишите реалистичную «рыбу», с настоящими реквизитами: ИНН, КПП, названиями организаций

Рамиль Шайхутдинов сделал плагин для Скетча RusBizGenerator. Он помогает вставлять в прототипы настоящие названия организаций, ФИО, ИНН и КПП, а еще генерирует номера, например ОГРН.

Вписывайте короткие, средние и длинные ФИО и адреса, а не те, которые с запасом влезают в поля

Пишите настоящие сообщения и ошибки из веб-сервиса, а не «Здесь текст ошибки»

Не пишите в прототипе «прикольные» и грубые имена и названия. Особенно в прототипе для тестирования

Не допускайте фактических и логических ошибок в прототипах

Бухгалтер разбирается в своей предметной области и сразу видит нестыковки. Фактические и логические ошибки в прототипе приводят к дискуссии с юзабилистом и мешают погружению в процесс.

Прототип с реквизитами настоящих организаций не должен выходить за пределы Контура. Для публикации в блогах и СМИ подготовьте скриншоты без реквизитов реальных организаций. Персональных данных людей это тоже касается

Термины

Используйте одни и те же слова для обозначения объектов и действий над ними

Если пользователь в одном окне прочитает «сертификат», в другом «КЭП», а в третьем — «ключ», у него не образуется связь между этими словами, он не поймет, что это одно и то же.

Чтобы избежать повтора в соседних предложениях, используйте разные способы указания

Для этого можно переходить с термина на местоимение или на имя собственное, а потом обратно. Переходить с одного термина на другой нельзя — такой текст будет путать пользователя.

Неправильно

Веб-сервис → Система → Сервис

Сертификат → Ключ → Электронная подпись

Правильно

Веб-сервис → Диадок → Он

Сертификат → Он

Как писать об оплате и продлении сервиса и о сертификате

Покупка и продление

Сервис можно купить либо оплатить. Когда сервис заканчивается, его можно продлить либо оплатить.

Пакет можно заказать, купить и оплатить.

Сертификат можно заказать либо выпустить. Когда сертификат заканчивается, его можно обновить, выпустить или заказать новый.

Окончание

Сервис и сертификат могут закончиться, а истечь может только их срок действия. Сами сервис и сертификат истечь не могут.

Источник

  • Чтобы это значило как пишется
  • Чтобы ты не делал не бойся как пишется
  • Что я хочу пожелать людям всего мира 4 класс сочинение коротко
  • Чтобы мне сегодня почитать как пишется слитно или раздельно
  • Чтоб никто не уволок сказка