Size: a a a

technicalwriters

2020 August 12

S

SystemA in technicalwriters
источник

S

SystemA in technicalwriters
Семён Факторович
Коллеги, в очередной раз напоминаю, что у нас не приняты негативные (и даже саркастические) комментарии к вакансиям.

Второй раз уже за сегодня.
Образовательный посыл был , а не отрицательный😌
источник

MB

Maria B in technicalwriters
#wanted_tw #вакансия

🔥ТЕХНИЧЕСКИЙ ПИСАТЕЛЬ по разработке и поддержке проектной (рабочей и эксплуатационной) документации, составлению тех.описаний (инструкций, руководств, методик) ИТ-инфраструктур, DR решений, СХД, СУБД.

☑️ Компания: Банк Топ-5
☑️ Зарплата 140 000 -160 000 net
☑️ Локация: удаленный формат работы
☑️ Занятость: fulltime

ЗАДАЧИ

🔸Разработка и поддержка руководств пользователя и администратора (эксплуатационная и проектная документация);
🔸Актуализация технической документации;
🔸Консультация команды в процессе проектирования в рамках разработанной документации;
🔸Взаимодействие с аналитиками, тестировщиками и разработчиками;
🔸Рецензирование документов и взаимодействие с подрядчиками.

ОТ ВАС ЖДЕМ

🔸Опыт работы в ИТ от 3-х лет по разработке проектной (рабочей, эксплуатационной) документации.
🔸Знание ГОСТ (34 группы, РД 50-34.698-90) в объеме, который необходим для создания документации по автоматизированным системам.
🔸Оформление технической документации в соответствии с требованиями ГОСТ 34.
🔸Создание технической документации и составление технических описаний (инструкции, руководства, методики и т.д.).
🔸Нормоконтроль проектной документации.
🔸Свободное владение пакетами MS Office, работа с графикой – Visio.
🔸Умение пользоваться нормативно-справочной литературой, технической документацией вендоров.
🔸Умение работать с текстами больших объемов, разрабатывать и поддерживать шаблоны документов.
🔸Грамотный русский язык; системное мышление.
🔸Базовые знания технологий построение HA/DR решений.
🔸Базовые знания СУБД Oracle/PostgreSQL.
🔸Базовые знания ОС Linux/AIX.
🔸Базовые знания корпоративных SAN, СХД.

ОТ НАС

🔸Официальное оформление по ТК РФ;
🔸Впечатляющий соц.пакет (ДМС, возможность внутреннего и внешнего обучения, получение сертификатов; льготные программы от компаний-партнеров (банки, страхование, фитнес, КОМУС, ОКЕЙ, сеть книжных магазинов).

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

Контакт @mariya_it
источник
2020 August 13

вд

всем добра in technicalwriters
Всем здравствуйте.В настоящее время курю мануалы по использованию плагина Scroll Export to Word for Confluence. Не сочтите за наглость, спешу поинтересоваться, нет ли у кого опыта работы с плагином Scroll Export to Word и в частности готового шаблона с настроенными стилями ? Знаю, что есть дефолтные, и их можно настраивать,(чем собственно сейчас и занимаюсь), но интересует шаблон для экспорта в ГОСТообразный документ, или хотя бы шаблон, который кто-то собственноручно уже кастомизировал
источник

D

Daria Sarafanova in technicalwriters
всем добра
Всем здравствуйте.В настоящее время курю мануалы по использованию плагина Scroll Export to Word for Confluence. Не сочтите за наглость, спешу поинтересоваться, нет ли у кого опыта работы с плагином Scroll Export to Word и в частности готового шаблона с настроенными стилями ? Знаю, что есть дефолтные, и их можно настраивать,(чем собственно сейчас и занимаюсь), но интересует шаблон для экспорта в ГОСТообразный документ, или хотя бы шаблон, который кто-то собственноручно уже кастомизировал
Добрый день! Мы юзали. Не советую для ГОСТ. Не подойдёт. Придется все равно ещё руками потом после экспорта править. Щас поищу шаблоны, если остались.
источник

вд

всем добра in technicalwriters
Daria Sarafanova
Добрый день! Мы юзали. Не советую для ГОСТ. Не подойдёт. Придется все равно ещё руками потом после экспорта править. Щас поищу шаблоны, если остались.
Буду невероятно признателен ! Ну хотя бы что-то около  well formed
источник

вд

всем добра in technicalwriters
Daria Sarafanova
Добрый день! Мы юзали. Не советую для ГОСТ. Не подойдёт. Придется все равно ещё руками потом после экспорта править. Щас поищу шаблоны, если остались.
Конечно костыльный метод, но как вариант прогонять контент экспортированный из Confluence ещё через какой-то сценарий...
источник

вд

всем добра in technicalwriters
источник

вд

всем добра in technicalwriters
источник
2020 August 14

СФ

Семён Факторович... in technicalwriters
Пятничный «отвести душу» челлендж:

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

MS

Maria Shabanova in technicalwriters
Навскидку приходит только инструкция к блендеру мулинекс, где были описаны функции всех насадок, кроме той, ради которой я полезла в инструкцию)
источник

NV

Nick Volynkin in technicalwriters
Семён Факторович
Пятничный «отвести душу» челлендж:

Накидайте, пожалуйста, примеры плохой документации (желательно, публичной), с которой вы столкнулись в последнее время.
Вот этот ридми https://github.com/Modernizr/Modernizr
ссылается на шаблон конфига https://github.com/Modernizr/Modernizr/blob/master/lib/config-all.json
в этом конфиге есть поле feature-detects и в нём список с названиями фич, они там пишутся через /
Но если использовать modernizr через gulp-modernizr, то gulp-modernizr внутри себя использует customizr, и у него конфиг точно такой же, только аналогичное поле называется tests и в нём названия фич пишутся слитно.

Я потратил часа два, пытаясь скормить gulp-modernizr конфиг из основного репозитория. Так и не понял, либо это специально несовместимые конфиги, либо забыли обновить ридми.
источник

NV

Nick Volynkin in technicalwriters
Вот это прям самое плохое, что было на этой неделе )
источник

NV

Nick Volynkin in technicalwriters
А ещё https://www.robotstxt.org/ ну такое себе.
источник

СФ

Семён Факторович... in technicalwriters
мои пять копеек:

- Недавно полазил по официальной reference-документации для команд Git (стандартные manpages), и они всё еще очень плохие, как и 7-8 лет назад. Для новичков они совершенно бесполезны (мы все знаем, что невозможно научиться гиту, читая manpages). Опытным же пользователям чаще всего нужны не объяснения низлежащих концепций (которых там 90%), а зато нужен емкий справочник ключей командной строки. Короче, совершенно не спозиционированная документация — непонятно кому написанная и непонятно зачем.

- Документация по certbot (бот для настройки TLS-сертификатов для Let's Encrypt) хорошая, но только если вы не натыкаетесь на ошибки выполнения. У меня всё завелось не с первого раза, и информации про ту ошибку, которую я получал, в официальной документации нет совсем. Решение в итоге нашел на каком-то польском(!) форуме:(

- Перелистал на свежую голову когда-то сильно хвалимый сборник статей The Architecture of Open Source Applications (http://aosabook.org/), и тоже расстроился. Все архитектурные статьи написаны с неравномерной глубиной описания, делают акценты на каких-то мелких (видимо, интересных авторам) деталях реализации, и в целом не создают полной картины того, как устроены эти продукты. Архитектурные доки — это сложно, да.
источник

NJ

Natalia Jones in technicalwriters
Burrito
У нас есть база сервиса аналитики. Отгадайте, как разрабы ее называют..
я наконец дочитала все новые сообщения и не вижу ответа на этот интригующий вопрос 😭
источник

СФ

Семён Факторович... in technicalwriters
а, ну и мы с @Nick_Volynkin раз от раза вспоминаем, что официальная документация по RST (https://docutils.sourceforge.io/rst.html#reference-documentation) ПРЯМ НЕ ОЧЕНЬ. То есть вся нужная инфа там есть, но ее поиск каждый раз как-то не радует.
источник

NV

Nick Volynkin in technicalwriters
Семён Факторович
а, ну и мы с @Nick_Volynkin раз от раза вспоминаем, что официальная документация по RST (https://docutils.sourceforge.io/rst.html#reference-documentation) ПРЯМ НЕ ОЧЕНЬ. То есть вся нужная инфа там есть, но ее поиск каждый раз как-то не радует.
она ужасная, я её ненавижу вместе с документацией Sphinx
источник

NV

Nick Volynkin in technicalwriters
Особенно в доке Sphinx я ненавижу, что там нет ссылки на гитхаб. И оглавления на первой странице — каждый раз ищу ссылку на него.
источник

NV

Nick Volynkin in technicalwriters
Семён Факторович
мои пять копеек:

- Недавно полазил по официальной reference-документации для команд Git (стандартные manpages), и они всё еще очень плохие, как и 7-8 лет назад. Для новичков они совершенно бесполезны (мы все знаем, что невозможно научиться гиту, читая manpages). Опытным же пользователям чаще всего нужны не объяснения низлежащих концепций (которых там 90%), а зато нужен емкий справочник ключей командной строки. Короче, совершенно не спозиционированная документация — непонятно кому написанная и непонятно зачем.

- Документация по certbot (бот для настройки TLS-сертификатов для Let's Encrypt) хорошая, но только если вы не натыкаетесь на ошибки выполнения. У меня всё завелось не с первого раза, и информации про ту ошибку, которую я получал, в официальной документации нет совсем. Решение в итоге нашел на каком-то польском(!) форуме:(

- Перелистал на свежую голову когда-то сильно хвалимый сборник статей The Architecture of Open Source Applications (http://aosabook.org/), и тоже расстроился. Все архитектурные статьи написаны с неравномерной глубиной описания, делают акценты на каких-то мелких (видимо, интересных авторам) деталях реализации, и в целом не создают полной картины того, как устроены эти продукты. Архитектурные доки — это сложно, да.
> окументация по certbot (бот для настройки TLS-сертификатов для Let's Encrypt) хорошая, но только если вы не натыкаетесь на ошибки выполнения.

Так эт самое, тебе надо Plesk поставить ) Он за тебя будет обновлять сертификаты.
источник