Size: a a a

Технические писатели

2021 October 29

ET

Eduard Tibet in Технические писатели
На самом деле, по сути это два разных курса с полностью непересекающимися темами :) По поводу managing - можете приобрести книгу: https://xmlpress.net/publications/managing-writers/
источник

D

Denis in Технические писатели
Да, я понимаю, поэтому и написал "или". Книга стоящая?
источник

ET

Eduard Tibet in Технические писатели
Могу сказать только косвенно :) Насколько я знаю, ее полностью читал @factorized . Семен, книга стоящая? :)
источник

АА

Анна Анна in Технические писатели
Коллеги, где взять векторы для корела для инструкции по сборке. Заказчик хочет, чтобы было как в инструкции в икее
источник

S

Sio in Технические писатели
Ну, эм, нарисовать?::) Есть ощущение, что у них в икее это рендеры с торидэ
источник

AT

Aleksandr Tokarev in Технические писатели
У вас вообще чертежи есть в какой либо программе ?
источник

СФ

Семён Факторович... in Технические писатели
книга точно не вредная:)
источник

IM

Igor Mironovsky in Технические писатели
ну это же ручной труд, ключевое слово было БЫСТРЕНЬКО, я не хочу 300 рисунков отбивать, методичка имелся в виду широко известный в узких кругах набор макросов http://mtdmacro.ru/ =)
источник

O[

Olga [olgademoscu] in Технические писатели
TIL :D
источник

АА

Анна Анна in Технические писатели
Да есть 3д модель
источник

AT

Aleksandr Tokarev in Технические писатели
Ну вот, формируете чертёж и сохраняете ее в формате Корала ))
источник

АА

Анна Анна in Технические писатели
Отвертки, стрелки руки в кореле добавлять?
источник

AT

Aleksandr Tokarev in Технические писатели
По желанию, я бы в Корале сделал
источник

AS

Andrei Serikov in Технические писатели
Tango — автоматическое создание руководств со скриншотами

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

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

Также доступно расширение в Chrome.

CIT #эффективность#эффективность
источник

MC

Milkhail Che in Технические писатели
Гайз, а кто-то смотрит https://archdays.ru/program/ ?
источник

MC

Milkhail Che in Технические писатели
Пропустил лекцию, может, у кого запись есть?
источник

MV

Maria Vasileva in Технические писатели
Добрый день! Подскажите, пожалуйста, доводилось ли кому-либо прорабатывать постановку процесса непрерывного обновления базы знаний в организации? RACI-матрица и т.п.?
источник

IS

Igor Shakhbazyan in Технические писатели
Kameraden,
Уже, бывало, поднимался вопрос об инструментах документирования, но сейчас он поднялся и у меня)
Сейчас стоит задача переехать с GitBook на что-то другое. Требования примерно следующие:
1. Возможность self-host на своих мощностях
2. Возможность какими-либо либо плагинами (что-то связанное со swagger) генерить и размещать документацию по REST.
2.1. В документации по REST обязательно будут блоки кода, желательно в них иметь подсветку синтаксиса.
3. Обязательно наличие продвинутой системы контроля версий
4. Максимальная кастомизируемость внешнего вида (чтобы можно было привести в соответствие с корп.стилем)
5. По возможности поддержка легковесных языков разметки (md / rst) as a plus.
6. Возможность подключения статических анализаторов (линтеров). Чтобы часть труда по ревью переложить на железные плечи.
7. Ну и возможность легко и просто прикручивать различные плагины (типа формы обратной связи, "Previous/Next Article" и так далее).

Сейчас смотрю на Github Pages, он, кмк, в той или иной степени отвечает этим требованиям. На нем, насколько я сделал вывод, многие крупные вендоры строят свою доку, типа Яндекс.Облако или Майкрософт.

Но хотелось бы и мнение сообщества выслушать) по правильному ли пути я иду? какие шишки набью? что мне еще посмотреть?
источник

V

Vasiliy in Технические писатели
разве github pages есть self-hosted?
источник

А

Александр Мокрушин... in Технические писатели
github pages - это же по сути хостинг для документации.

все зависит от языка разметки, который вы выберите.

md - очень много вариантов. Можно посмотреть в сторону Foliant, например.
rst - sphinx
asciidoc - Antora, AsciiDoctor
источник