Apple выпустила обновлённое руководство для пользователей iPhone. Компания разъяснила, как безопасно заряжать устройство, а также попросила не спать на нём.
В iFixit разобрали новый MacBook Pro и протестировали руководства по ремонту Apple
1 min
Специалисты iFixit решили протестировать официальные руководства по ремонту Apple, разобрав только что выпущенный 14-дюймовый MacBook Pro.
Как с помощью руководства пользователя повысить качество информационной системы
7 min
В действительности все совершенно иначе, чем на самом деле.
Антуан де Сент-Экзюпери
Многое в разработке руководства пользователя регламентировано и описано ГОСТами. Но при создании больших гетерогенных систем могут возникать вопросы, не до конца освещенные этими документами.
Отношение к руководству пользователя бывает разным. Многие совсем не задаются вопросом, каковы место и роль документа в процессе разработки больших гетерогенных информационных систем, для других же все и так ясно. Не спешите. В статье мы рассмотрим подходы к организации процесса создания и поддержания в актуальном состоянии этого важного документа, оценим значимость руководства пользователя для всей информационной системы в целом и придем к некоторым неожиданным выводам.
Статья будет полезна для тестировщиков, технических писателей, аналитиков и даже для руководителей проектов.
Антуан де Сент-Экзюпери
Многое в разработке руководства пользователя регламентировано и описано ГОСТами. Но при создании больших гетерогенных систем могут возникать вопросы, не до конца освещенные этими документами.
Отношение к руководству пользователя бывает разным. Многие совсем не задаются вопросом, каковы место и роль документа в процессе разработки больших гетерогенных информационных систем, для других же все и так ясно. Не спешите. В статье мы рассмотрим подходы к организации процесса создания и поддержания в актуальном состоянии этого важного документа, оценим значимость руководства пользователя для всей информационной системы в целом и придем к некоторым неожиданным выводам.
Статья будет полезна для тестировщиков, технических писателей, аналитиков и даже для руководителей проектов.
Советы как подготовить справку пользователя для ПО на английском
5 min
Привет! Сегодня мы открываем блог на Хабре. Наша специализация – переводы на английский язык, написание и рассылка пресс-релизов в Рунете, а также создание справочных систем для ПО. За несколько лет работы накопились некоторые знания, которыми хотим поделиться с вами. Надеюсь, что блог будет вам полезен. Желаю приятного прочтения и жду вас в постоянных посетителях.
Начинаем мы с поста о создании руководств пользователя для софта на английском языке. Cправка пользователя – это важная составляющая программного продукта. Создание справки требует особой тщательности, т.к. ошибки и непонятные формулировки в ней часто воспринимаются как дефект самой программы и портят впечатление о продукте. Журналисты упоминают плохо написанную или переведенную справку как недостаток в обзорах, а пользователи голосуют рублем – если они с трудом или вообще не понимают инструкции в руководстве, то едва ли они зарегистрируют триал. С другой стороны программу с качественно переведенной справкой легче продать.
Начинаем мы с поста о создании руководств пользователя для софта на английском языке. Cправка пользователя – это важная составляющая программного продукта. Создание справки требует особой тщательности, т.к. ошибки и непонятные формулировки в ней часто воспринимаются как дефект самой программы и портят впечатление о продукте. Журналисты упоминают плохо написанную или переведенную справку как недостаток в обзорах, а пользователи голосуют рублем – если они с трудом или вообще не понимают инструкции в руководстве, то едва ли они зарегистрируют триал. С другой стороны программу с качественно переведенной справкой легче продать.
Памятка пользователям ssh
13 min
abstract: В статье описаны продвинутые функций OpenSSH, которые позволяют сильно упростить жизнь системным администраторам и программистам, которые не боятся шелла. В отличие от большинства руководств, которые кроме ключей и -L/D/R опций ничего не описывают, я попытался собрать все интересные фичи и удобства, которые с собой несёт ssh.Предупреждение: пост очень объёмный, но для удобства использования я решил не резать его на части.
Оглавление:
- управление ключами
- копирование файлов через ssh
- Проброс потоков ввода/вывода
- Монтирование удалённой FS через ssh
- Удалённое исполнение кода
- Алиасы и опции для подключений в .ssh/config
- Опции по-умолчанию
- Проброс X-сервера
- ssh в качестве socks-proxy
- Проброс портов — прямой и обратный
- Реверс-сокс-прокси
- туннелирование L2/L3 трафика
- Проброс агента авторизации
- Туннелирование ssh через ssh сквозь недоверенный сервер (с большой вероятностью вы этого не знаете)
Рекомендации по подаче питания на СВЧ усилители (перевод)
7 min
Translation
от автора перевода:
Я разрабатываю различные устройства СВЧ, в том числе усилители и усилительные модули. Файл с этим руководством я обнаружила, когда смотрела разные документы к одному из усилителей Qorvo, который собиралась использовать в своём следующем проекте.
Рекомендации могут быть полезны не только при работе с усилителями на основе GaN, но также содержат некоторые тонкости, полезные для любых микросхем.
Рекомендую прочесть эту небольшую статью всем, кто работает с транзисторными усилителями, ведь цена ошибки может достигать 100 тысяч рублей.
Руководство пользователя на русском в формате chm
1 min
Для тех у кого интернет не всегда под рукой, да и просто для любителей локальных мануалов, я скомпилировал руководство пользователя по CodeIgniter (code-igniter.ru) в отдельный файл chm.
Скачать его можно отсюда: www.iforyou.ru
UPD 1: Добавлена страничка с классом Image Manipulation.
UPD 2: Добавлена страничка с классом Typography.
UPD 3: Удалено выпадающее содержание (то что на JavaScript), панель справа теперь в юникоде.
UPD 4: Страница с содержанием теперь в две колонки.
UPD 5: Исправлена ошибка с кодом в одну линию. Теперь код как в оригинале.
Скачать его можно отсюда: www.iforyou.ru
UPD 1: Добавлена страничка с классом Image Manipulation.
UPD 2: Добавлена страничка с классом Typography.
UPD 3: Удалено выпадающее содержание (то что на JavaScript), панель справа теперь в юникоде.
UPD 4: Страница с содержанием теперь в две колонки.
UPD 5: Исправлена ошибка с кодом в одну линию. Теперь код как в оригинале.
Туториал для туториалов. Как написать пользовательскую документацию
12 min
Есть устоявшеёся мнение, что для хороших продуктов руководство пользователя не нужно. Очередной холивар на эту тему разгорелся в нашем рабочем чате. Я не до конца согласен с этим утверждением.
Хороший интерфейс действительно должен помогать пользователю быстро понять продукт и научиться им пользоваться. Как всегда есть пара НО.
Разработка пользовательской документации для включения ПО в Реестр отечественных программ Минцифра России
6 min
Как попасть в Реестр отечественного ПО Минцифра? Зачем? И причем тут пользовательская документация.
10 вредных советов для документации
3 min
Наша команда много лет занимается разработкой программы для создания пользовательской документации. За это время мы столкнулись с бесчисленным множеством руководств, анализировали и проверяли документацию наших клиентов, создавали свою собственную документацию, добавляли новые фичи и так далее.
В общем, наш путь был долог и интересен, но он еще далеко не закончился. Сегодня хочу поделиться с вами опытом технического писателя и в немного (или много) сатирической форме предостеречь от классических, но очень серьезных ошибок при написании и публикации пользовательской документации, с которыми часто сталкивались в руководствах наших клиентов.
И так, поехали – 8 классических способов сделать вашу документацию ненавистной для пользователя.
Организация разделов на системном диске в облаке Селектел
4 min
abstract: Этот пост описывает организацию системного диска на машинах в облаке и объясняет, почему именно так.
Предисловие: Всё написанное тут касается системных дисков создаваемых при установке виртуальных машин. Пользователи имеют полное право делать что хотят с этими дисками, и уж, тем паче, решать самостоятельно, как организовывать место на дополнительных дисках.
Мы должны предоставлять диски системы в таком виде, который даст пользователям достаточную свободу делать «что хочешь», и в то же время обеспечивать достаточную простоту и удобство для пользователей, которым нужно «просто работать». Хотя проблема чуть более сложная, поскольку речь идёт не об удобном пульте телевизора, а об инструменте в работе, так что правильнее говорить про удобство типовых сценариев и возможность реализовывать свои собственные.
Вот проблемы, которые возникают в связи с этим:
Наиболее примитивным решением является
Предисловие: Всё написанное тут касается системных дисков создаваемых при установке виртуальных машин. Пользователи имеют полное право делать что хотят с этими дисками, и уж, тем паче, решать самостоятельно, как организовывать место на дополнительных дисках.
Мотивация
Мы должны предоставлять диски системы в таком виде, который даст пользователям достаточную свободу делать «что хочешь», и в то же время обеспечивать достаточную простоту и удобство для пользователей, которым нужно «просто работать». Хотя проблема чуть более сложная, поскольку речь идёт не об удобном пульте телевизора, а об инструменте в работе, так что правильнее говорить про удобство типовых сценариев и возможность реализовывать свои собственные.
Вот проблемы, которые возникают в связи с этим:
- Возможность изменить размер диска и корневой файловой системы
- Возможность создать дополнительные разделы
- Возможность подключить диски от одной машине к другой
- С этого диска надо ещё и загрузиться
Наиболее примитивным решением является
Самое первое руководство по Фортрану
2 min
Приходилось ли вам когда-нибудь писать код на Фортране? Даже если ответ будет отрицательным, вы наверняка используете системы, которые были разработаны или работают на нём. Это первый язык программирования высокого уровня с использованием абстракций. Можно сказать, что именно с Фортрана зародилось современное программирование.
В этом году исполнилось 56 лет самому первому руководству пользователя по Фортрану, которое вышло 15 октября 1956 года. Скачать его можно здесь.
Виды и форматы справок
4 min
Привет, Хабр!
К нам в Alconost часто приходят клиенты и говорят “Мне нужна справочная система для моей программы. Сделайте мне ПэДээФку”. Мы создаем руководство пользователя, оформляем PDF, а потом оказывается, что на самом деле нужна была контекстная справка с индексом и поиском.
Именно поэтому хотелось бы поделиться со всеми простыми схемами и описанием видов и форматов справки.
К нам в Alconost часто приходят клиенты и говорят “Мне нужна справочная система для моей программы. Сделайте мне ПэДээФку”. Мы создаем руководство пользователя, оформляем PDF, а потом оказывается, что на самом деле нужна была контекстная справка с индексом и поиском.
Именно поэтому хотелось бы поделиться со всеми простыми схемами и описанием видов и форматов справки.
PADS Professional — Быстрый старт
2 min
Tutorial
Доброго времени суток, уважаемый читатель!
Компания Mentor Graphics совместно с Нанософт разработали краткое руководство пользователя в виде серии уроков, которые познакомят начинающих пользователей с базовым функционалом САПР PADS Professional.
За более подробной информацией добро пожаловать под кат.