Академические тексты - кайф

научные — да, наукообразные — мерзость

Не буду занудствовать 😏

Тотемное животное же

Есть пояснение как это оскорбляет их? И вообще данные оскорбляет ли вообще?

Опять повесточка. Почему я не удивлён?..

Пишем FAQ.
Есть 3 разные проблемы, которые имеют одинаковые симптомы и ищутся по одинаковым словам.

Эти 3 проблемы стоит описать как 3 разных вопроса или сгруппировать в одном?

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

Возможно, стоит сделать 3 разных вопроса, но решение описать в одном, а в остальных дать ссылки на первый

Или везде вставить один и тот же текст, если single-source документация

Так решение для 3 проблем разное

Тогда 3 разных вопроса

Если симптомы одинаковые - разве это не поэтапное исключение причин проблемы?
У меня не включается компуктер, что делать?
Возможно, у вас выключен монитор. Нажмите на кнопочку на мониторе.
Возможно, это уборщица. Проверьте подключение кампуктера к сети.
Возможно, у вас вообще отключено электричество. Проверьте, работают ли другие электроприборы.
Не?

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

#wanted_tw #самара #вакансия #fulltime

Компания "Axbit-IT" (г.Самара)
Вакансия: технический писатель
Условия труда: офис в центре города, не удаленка
Зарплата: по результатам собеседования

Обязанности:

- Написание и оформление документации по ГОСТ 19, 34.
- Содействие проектной команде в оформлении и создании проектной документации: ЧТЗ, спецификации, инструкции и руководства пользователей, описание интеграционных интерфейсов.
- Разработка проектной документации.
- Анализ и формализация бизнес-требований на разработку ПО, взаимодействие с командой разработчиков при постановке задачи,
- Разработка и поддержание в актуальном состоянии проектной документации: технических заданий, описаний функционала и отчетности, инструкций.

Требования:

- Русский язык: грамотная письменная речь, умение ясно и доступно излагать мысли.
- Понимание структуры документов, умение организовать информацию, умение создавать, редактировать, иллюстрировать и адаптировать технический материал лаконично и понятно.
- Опыт разработки технической документации в сфере ИТ.
- Умение представить информацию в наглядном виде.

Преимуществом будет

- Умение и желание быстро освоить новую информацию, разбираться в предметной области.
- Знание принципов построения пользовательских интерфейсов и понимание архитектуры разрабатываемых решений.
- Приветствуется наличие навыков работы с продуктами Atlassian - Jira и Confluence

Условия:

- Участие в разработке и развитии IT продуктов в сфере медицины, правительства и финансов;
- Оформление согласно ТК РФ;
- Гибкое начало дня;
- Профессиональный и дружный коллектив;
- Индивидуальный подход к каждому человеку в команде;
- Офис в шаговой доступности от м. Алабинская;

МЫ готовы также обучить всем необходимым навыкам начинающего Технического писателя. Отклики направляйте в личку.

F.A.Q. больше про вопросы, а не про решения.

В каком смысле?

В смысле адресации. Если я пришёл туда, потому что у меня BSOD при запуске системы, а вы -- потому что  WinPCAP не стартует, а решение в переустановке уровня протокола, нужно и мне, и вам дать персональное решение.

Иногда, если решение длинное, можно отдельно его описать, а потом в каждом вопросе на него сослаться.

Хоть кто-то написал "преимущество" вместо набившего оскомину "плюса". Jezus Maria!

Сфинкс и питон - это хорошо, но для новичка сложно, мне кажется. Рекомендую попробовать AsciiDoc и Antora. Достаточно просто, если нужно только создать сайт. Если нужно создать и поковыряться, то есть куда углубиться.

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

Что подразумевается под графической документацией?