Введение
В ИТ-компаниях не сразу пришли к тому, что нужен технический писатель, а про нормоконтроль вообще не задумываются, пока не придет пачка замечаний от заказчика.
Рубрика «Подготовка технической документации»
Правила хорошего тона при оформлении технической документации
2023-07-11 в 9:11, admin, рубрики: word, Блог компании Bimeister, гост, документация, нормоконтроль эпд, Подготовка технической документации, разработка документации
Опыт организации труда в конструкторском бюро (часть II)
2023-05-06 в 19:18, admin, рубрики: PDM, бизнес, бухгалтерия, виртуализация, конструкторское бюро, облачные сервисы, планирование, Подготовка технической документации, проектирование, удалёнка, управление людьми, управление персоналом, управление проектами, чертежиДва с половиной года назад я написал первую статью на эту тему. Когда я наткнулся на неё в 2023, я подумал, что за последние годы многое поменялось в нашей работе жизни и мне есть о чём вам рассказать. Статья имеет узкую направленность и в первую очередь нацелена на начинающих предпринимателей, так как в ней рассмотрено много полезных бизнес-инструментов, которые стоят не очень дорого.
Нужен ли офис конструкторам?
Мой поиск аналога Microsoft Visio
2023-04-23 в 13:55, admin, рубрики: diagrams, Visio, Visual Studio, Анализ и проектирование систем, визуализация данных, графика, диаграмма, диаграммы, инженерные системы, Подготовка технической документации, приложения, чертежиДоброго дня всем.
В сегодняшней статье хотел бы поделиться проведенным анализом приложений, потенциально способных заменить MS Visio для разного рода задач.
Откуда возникла такая потребность
На самом деле, я давно работаю в Визио. Еще со студенческих времен рисую там блок-схемы для бизнес-процессов, различных функций и алгоритмов, просто чтобы не запутаться. Это мой must have при разработке сложных частей приложений.
Сейчас у меня закончилась лицензия MS Office, и я решил изучить рынок на предмет существующих аналогов. Возможно, эта тема заинтересует вас тоже, и я смогу помочь в решении подобной проблемы.
Читать полностью »
Как писать конспекты на компьютере быстрее, чем от руки, при помощи VS Code
2023-01-20 в 11:32, admin, рубрики: javascript, latex, Visual Studio, vsc, конспектирование, математика, Подготовка технической документации
Введение
Далее будут описываться способы ускорения набора LaTeX-овского текста, поэтому если Вы не знаете, что такое LaTeX, то Вам придется изучить это самостоятельно (может кто оставит полезные ссылки в комментариях).
Манулы и мануалы: можно ли избавиться от дурацких описок в технических текстах
2022-12-24 в 11:18, admin, рубрики: gtd, spellchecker, документация, Лайфхаки для гиков, мануал, мануалы, манул, описки, орфография, ошибки, Подготовка технической документации, проверка орфографии, Терминология IT, технические тексты, Читальный зал
Как использовать макросы в Confluence, чтобы систематизировать и оформить документацию по продукту и процессам?
2022-11-16 в 8:57, admin, рубрики: atlassian, confluence, selectel, Блог компании Selectel, макросы, Подготовка технической документации
Привет! Меня зовут Таня Дудо, и я уже 6 лет помогаю людям и командам обмениваться знаниями внутри компаний. Для этого использую Confluence. Да-да, ту самую wiki-систему, которую часто называют неудобной и несовременной. Сегодня выступлю ее адвокатом-обозревателем: расскажу про 7 полезных макросов для систематизации и оформления контента и наглядно покажу, как они работают.
Дисклеймер: с марта Atlassian не продают лицензии в Россию напрямую. Но если у вас уже есть, никто не запрещает ей пользоваться. На сайте Atlassian есть развернутая документация по установке Confluence и Jira. Она охватывает практически все аспекты. Вот, например, одна из статей.
Читать полностью »
Создание системы документирования, или как мы от «ворда» к docs as code за месяц переходили
2022-09-05 в 7:36, admin, рубрики: devops, reStructeredText, sphinx, Блог компании Cloud, Подготовка технической документации, справка, техническая документацияПривет! Меня зовут Юрий Никулин, и я руководитель направления документирования Cloud. Сегодня расскажу, как мы перешли с документирования в Word на подход docs as code и почему в качестве языка разметки выбрали reStructuredText.
Почему мы этим занялись
Язык Dot для Автогенерации Блок Схем Сложных Электронных Цепей
2022-08-13 в 15:24, admin, рубрики: BlockDiagram, diy или сделай сам, doc, dot, GraphViz, inkscape, mcu, NRF5340, schematics, svg, vector graphics, Подготовка технической документации, программирование микроконтроллеров, схемотехникаСовременные печатные платы достигают очень высокого уровня сложности. Особенно трудно разобраться в логике цепей питания. Так же сложность добавляет тот факт, что схемотехника от вендора в *.pdf дискретная. На схеме есть летающие фрагменты.
В поисках минимального ТЗ
2022-04-10 в 12:45, admin, рубрики: CRM, CRM-системы, документация, менеджмент, Подготовка технической документации, политика, управление проектами