Всё о деятельности технических писателей
Я решил опробовать метод «грубого вмешательства» при необходимости замены шрифтов используемых в стилях документа MS Word.
Данная статья опубликована в хабе Подготовка технической документации, поэтому в ней не содержится лютого хакинга и прочего колдунства…
Хабр, привет! Меня зовут Витя, я работаю системным аналитиком, сегодня хочу рассказать про такой обязательный навык аналитиков, как проектирование процессов. Думаю, что каждый, кто будет работать на позиции системного/бизнес аналитика, рано или поздно столкнется с такой задачей.
Помните историю про "танцующий" мост? Эти тёплые времена, когда новости были просто интересными, а не вызывали посттравматическое расстройство...
В этой статье посмотрим, как выполняются инженерные расчёты и почему мост пустился в пляс. Добро пожаловать в наш инженерный клуб!
Каждый системный и бизнес-аналитик проходит "боевое крещение" в своей карьере, когда получает первую задачу на проектирование интеграций. Звучит серьезно и сложно. И это так, если ни разу не работал с таким видом задач.
С чего начать и куда смотреть при работе с задачами на интеграции? Давайте воспользуемся пошаговой инструкцией, чтобы понять план действий.
Огромный объём документации по функционалу библиотек Qt уже включён в состав дистрибутива Qt Creator. Таким образом, при работе над кодом не нужно переключаться между IDE и веб-браузером чтобы найти интересующую информацию. Очень удобно!
Но как быть, если хочется иметь свою справку на свой продукт, и чтобы её было также удобно использовать в работе в Qt Creator, наряду со стандартной справкой Qt? Чтобы можно было переходить из редактора кода непосредственно на страницы интересующих нас функций/типов/классов или же каких-то статей?
В данной статье пошагово разберём алгоритм составления и интеграции справки в Qt Creator, а также поделимся собственным опытом.
Многие начинающие геймдизайнеры считают, что их идеи, если не гениальны, то как минимум классные и имеют право на реализацию. Во многом это, действительно, так. Сколько идей новых игр вы придумали за свою жизнь? Возможно, десятки? А теперь ответьте себе, сколько своих идей вы довели до релиза игры, которая выложена в доступ игрокам.
В этой статье я поделюсь опытом, как начинаю разработку новой игры. Не важно, делаем мы инди продукт, PC или мобайл. Даже если мы видим в играх в первую очередь искусство, я считаю полезным знать, во что нам обойдётся то или иное произведение.
Два с половиной года назад я написал первую статью на эту тему. Когда я наткнулся на неё в 2023, я подумал, что за последние годы многое поменялось в нашей работе жизни и мне есть о чём вам рассказать. Статья будет полезна всем кто интересуется различными схемами организации труда в коллективе и IT инструментами, которые помогают в этой организации.
Любой успешный проект начинается с ясного и понятного плана, который определяет направление работы и описывает подход к его реализации. Проработка проекта на ранних этапах с достаточным уровнем детализации экономит время во время разработки и позволяет успешно завершить проект в предсказанные сроки и бюджет. Именно для этой цели и созданы технические дизайн документы ("design doc" или "дизайн док"). Дизайн документы помогают разработчикам понимать основные требования к проекту, его архитектуру и функциональные возможности, а также процессы обеспечения безопасности и отказоустойчивости, масштабирования и эксплуатации.
Хороший технический документ может стать ключевым инструментом для общения и взаимодействия между разработчиками, менеджерами проекта и другими заинтересованными сторонами. Он помогает улучшить понимание целей проекта, улучшить качество продукта и сократить время, затраченное на разработку.
В этой статье мы рассмотрим, что такое дизайн документы, зачем они нужны и как их создавать с максимальной пользой для проекта.
За время карьеры, чаще всего сталкивался с ситуацией, когда получаешь проект в котором непонятно где «вход», где «выход» и один только вопрос — «куда ткнуть?!». Товарищи, давшие проект, говорят, что «это делал Вася, но он уже уволился, а на звонки не отвечает и никто не знает что к чему». Знакомая ситуация? Так же много раз после перебросок между многочисленными проектами, бывало встречалась ситуацию, когда смотришь непонимающе на код, а в коммитах автором видишь своё имя, но уже не помнишь вообще что к чему и как писал. Знакомо? В какой то момент меня стала доставать такая ситуация и я сделал себе небольшую автоматизацию, что бы снизить количество проблем и ненужных нагрузок на мозг, это — карта проекта.
В данной статье мы расскажем как перевести статический веб-сайт с Markdown (Zola, Hugo, Jekyll, Pelican, Gatsby, и д.р.) на все языки мира и поддерживать переводы в актуальном состоянии при изменении исходных текстов.
Проблемы ведения строительных журналов (общего журнала работ, журнала авторского надзора и других специальных журналов) на бумажном носителе в рукописном виде широко известны и подробно рассмотрены в работах А.С. Карпушкина [1], К.С. Петрова [2] и Н.В Цопа [3], где перечислены следующие проблемы:
Доброго дня всем.
В сегодняшней статье хотел бы поделиться проведенным анализом приложений, потенциально способных заменить MS Visio для разного рода задач.
Кажется в кино кризис — хороших фильмов один на сотню. Могу предложить один сюжет — психологический триллер. Сценарий для него будет начинаться со строк: «Была у нас одна легаси-система. Монолитная. И задумали мы провести миграцию...»
Предполагается, что имеется репозитарий (repository, хранилище данных) корпоративной архитектуры, например, в виде файла excel или источника, связанного по ODBC.
Задача: на основе данных из репозитария, содержащего объекты архитектуры предприятия (процессы, орг-структура, активы и т.п.), автоматически построить схему архитектуры: сгенерировать дерево на основе данных об иерархии объектов. Рассмотрен инструментарий excel и visio (сторонних add-in), приведена сопутствующая критика этих Microsoft-инструментов.
Генерация структурных схем штатным мастером Орг-диаграмм visio по данным excel (ODBC) аналогична табличному csv или скриптовым языкам dot, mermaid, plantUML в инструментах graphviz и drawio, а также rdf-триплетам (linked data), визуализируемым через RDF grapher. Генерация штатным мастером ограничена древовидными структурами, но использование visio VBA позволяет устранить ограничение древовидности, «Но это уже совсем другая история».
В предыдущей статье Простая Enterprise Architecture. Архитектура компании садоводов было рассказано про само понятие «корпоративная архитектура» (что такое Enterprise Architecture, ЕА) и объект архитектуривания (корпорация садоводов, СНТ).
В том примере нужно было вручную рисовать архитектурные схемы (структурные и VAD – цепочка добавленной стоимости) и далее связывать данные excel c фигурами visio в ручном (путем перетаскивания строк из поля «Внешние данные») или в автоматическом (автоматическое связывание по ID) режиме. В этой статье обойдемся без ручной работы: будет показан пример технологии автоматического построения иерархической схемы по данным, хранящимся в репозитарии - файле excel (аналогично автопостроение возможно из базы данных, иных источников ODBC).
Привет! Меня зовут Максим Павлов, я управляющий партнёр KTS и отвечаю за направление системной и бизнес-аналитики.
Некоторые команды относятся к написанию документации весьма догматично — либо пишут всегда, либо не пишут вообще. Мы в KTS стараемся избегать каких-то постулатов и всегда отталкиваться от конкретного кейса.
В материале расскажу, какие в этом вопросе бывают подходы, их плюсы и минусы, и какого подхода придерживаемся мы.
Требования ГОСТов относятся не только к оформлению документов, но и к их содержанию. В частности, ГОСТы определяют смысловое наполнение всех разделов, а также требования к изложению текста документа.
Как правило, в разработке технической документации принимают участие несколько специалистов, каждый из которых излагает свою часть в присущей ему манере, используя собственные термины. При формировании полного текста документа эти особенности требуют приведения к единообразию.
В далёком 2021 году нас пригласили поучаствовать в проекте по модернизации одного крупного горно-обогатительного комбината. В назначенный день мы вылетели в сторону Дальнего Востока. О том, что из этого вышло и почему словосочетание "3D сканер" заставляет наших конструкторов быть вдвойне более внимательными, читаем внутри!
Сотни отечественных ИТ‑решений, входящих в российский банк данных, способны обеспечить синхронизацию процессов и сокращение издержек в отрасли. Параллельно формируется экосистема индустрии, устроенная по принципу цифровой вертикали, в которую входят различные ГИС, объединяющие градостроительные нормы. Эксперты называют российскую строительную отрасль одной из передовых по темпам внедрения новых стандартов.
Существует замечательная теория, что все проблемы с хранением пользовательских данных в базах — это последствие отсутствия единых идентификаторов. Дескать, номер паспорта может меняться, ФИО может дублироваться у нескольких пользователей, а «внутренние» идентификационные номера в различных ведомствах могут не совпадать.
И стоит только провести массовую персонализацию (централизованное присвоение всем гражданам и негражданам специальных идентификаторов), как все проблемы будут решены и наступит цифровой рай.
Так оно или нет? Можно спорить, можно смотреть на опыт внедривших стран. Я же постараюсь описать типовые ошибки при проектировании и разработке систем, хранящих Единый Идентификатор.
