Решения и услуги для среднего бизнеса

Спектр решений и услуг для этого сегмента рынка выделен зеленым цветом на общей схеме:

Решения и услуги ТехРайтКонсалт

Разработка технической документации на заказ
Аутсорсинг разработки документации под ключ
Организация разработки документации предприятия
Поддержка разработанной документации
Схемы и диаграммы, прототипы интерфейса
Бизнес-анализ (включая обратное проектирование)
Анализ исходного кода ПО (реверс-инжиниринг)
Автоматизация обработки и анализа исходных данных
Вопросы безопасности и конфиденциальности

Разработка технической документации на заказ

Основная наша услуга: вы предоставляете нам только исходные данные по своему проектируемому/описываемому продукту и назначение (виды) создаваемых документов – всё остальное, от выбора формата до согласования готовых документов, мы берем на себя. Таким образом, мы все делаем самостоятельно, а вы получаете в конце полностью готовый комплект в требуемом формате.

☑ Мы самостоятельно создадим для вашего продукта/проекта комплект документов “под ключ” с нуля.

С какими форматами документов мы работаем?
DOC(X) Microsoft Word Document;
EPUB EPUB;
FB2 FictionBook 2;
ICML Adobe InDesign ICML;
JSON Custom JSON, CSL JSON;
MD (Multi)Markdown (Markua);
ORG/MUSE Emacs Org-Mode/Muse;
PDF Adobe PDF;
RIS RIS, IPYNB Jupyter notebook (ipynb);
ROFF/MS roff man/ms;
RST reStructuredText;
RTF Rich Text Format;
T2T txt2tags;
TEX/BIB LaTeX (ConTeXt), Bib(La)TeX;
TEXI GNU Texinfo;
TEXTILE Textile;
TOML TOML;
TYP Typst;
XML Custom, DocBook 4(5), JATS, BITS, TEI Simple, EndNote XML, OPML;
YAML Custom YAML, CSL YAML;
(F)ODT OpenDocument Format;
(L)HS Haddock;
(M)HTML HTML(5);
(XT)WIKI MediaWiki, CreoleWiki, DokuWiki, JiraWiki, TikiWiki, TWiki, Vimwiki, XWiki, ZimWiki markup;
A(SCII)DOC AsciiDoc;
C(T)SV C(T)SV tables;

Аутсорсинг разработки документации под ключ

Фактически услуга выше, но мы берем не только документирование какой-либо отдельного продукта/проекта – мы берем на себя всю документацию вашей компании целиком. При этом возможны несколько вариантов взаимодействия, одна в любом случае работа производится в прозрачном и безопасном режиме. Таким образом, вы можете полностью исключить построение и поддержку недешевых процессов документирования в вашей организации и избежать дополнительных расходов в виде поиска и найма дополнительных сотрудников в штат, а текущие ресурсы освободить и перераспределить более рационально.

☑ Мы возьмем на себя все процессы и вопросы вашей компании, связанные с техническим документированием.

Подробнее про аутсорсинг разработки документации в отдельной статье ➡️ 

Организация разработки документации предприятия

В некоторых случаях недостаточно и услуги выше: в таком случае мы можем организовать с нуля техническое документирование внутри вашей организации, включая вопросы взаимодействия с вашими партнерами и другими внешними контрагентами.

☑ Мы все организуем и настроим внутри вашей компании, а вы сможете продолжить работу самостоятельно.

Организация разработки документации предприятия обсуждается в индивидуальном порядке  ➡️ 

Поддержка разработанной документации

Иногда бывают случаи: все работы по созданию и выпуску завершены, однако теперь готовые документы необходимо постоянно поддерживать в актуальном состоянии по мере дальнейшей доработки/модификации ПО. При этом у вас нет либо свободных ресурсов, либо желания перераспределять имеющиеся ресурсы в пользу данного процесса (что правильно). В таком случае мы также можем взять эти процессы на себя, но здесь есть ряд исключений: например, как правило, мы беремся за поддержку и доработку только тех документов, которую как минимум полностью переработали и привели в требуемый вид, как максимум – создали изначально сами.

☑ Мы также можем взять всю поддержку на себя.

Поддержка разработанной документации, если иное предварительно не обговорено иначе, осуществляется при наличии свободных ресурсов на условиях почасовой оплаты  ➡️ 

Схемы и диаграммы, прототипы интерфейса

Как правило, в процессе работы мы бесплатно добавляем в создаваемые доки необходимые графические иллюстрации (например, скриншоты), однако в некоторых случаях такого уровня недостаточно: например, вы хотите для лучшего понимания добавить какие-либо сложные схемы или диаграммы (например, в нотации UML). Другая ситуация: текстового описания интерфейса проектируемого программного обеспечения по мнению вашего заказчика недостаточно – в этом случае возможно дополнение прототипами пользовательского интерфейса, при этом с нашей стороны данные элементы проектирует человек, который имеет большой опыт в данной области.

☑ Мы оформим для вас схемы и диаграммы любой сложности, а также в случае необходимости создадим и прототипы интерфейса.

С какими форматами схем, диаграмм и прототипов мы работаем?
ARCHIMATE ArchiMate Model;
DOCX Microsoft Word Document;
DRAWIO Draw.io Diagram;
FIGMA Figma Design File;
GIF Graphics Interchange Format;
JPG Joint Photographic Experts Group;
MD Markdown Extra;
PDN Paint.NET Image File;
PNG Portable Network Graphics;
RP Axure RP Project;
SNAG Snagit Capture File;
SVG Scalable Vector Graphics;
VSDX Microsoft Visio Drawing;
WEBP WebP Image;

Бизнес-анализ (включая обратное проектирование)

Очень часто при разработке проектной документации приходится “на лету” производить обследование и анализ существующей системы на экспертном уровне, а иногда и принимать непосредственное участие в проектировании новой системы – это требует уже определенной компетенции за пределами разработки эксплуатационной документации. Другая ситуация: к нам часто обращаются с обратной задачей, когда создание ПО завершено, а документирование не производилось в принципе – в этом случае мы производим так называемое “обратное проектирование”, т.е. воссоздаем комплект документов на основе анализа готового ПО таким образом, чтобы всё соответствовало всем этапам создания вашего ПО по ГОСТам или без.

☑ Мы самостоятельно проведем обследование и тщательный анализ вашей текущей системы, либо поможем надежно и быстро спроектировать новую по вашим требованиям.

Такие работы требуют достаточно много ресурсов, включая время и деньги  ➡️ 

Анализ исходного кода ПО (реверс-инжиниринг)

Иногда бизнес-анализ (включая обратное проектирование) изначально затруднен или невозможен в силу ряда причин: например, вы просто не знаете внутренне устройство функционирующего ПО (команда программистов сменилась, документирование не производилось). Другая ситуация: есть изначальная задача по созданию “низкоуровневой” документации, т.е. необходимо анализировать и документировать исходный код ПО. В этом случае мы производим так называемый “реверс-инжиниринг”, т.е. изучаем логику работы ПО на самом низком уровне и воссоздаем комплект документов на основе результатов этого анализа с требуемым уровнем детализации.

☑ Мы установим логику работу и основные алгоритмы системы, при необходимости проведем детальный анализ исходного кода, после чего тщательным образом всё задокументируем и предоставим это вам.

Работают отдельные специалисты: запросить возможность оказания услуги  ➡️ 

Автоматизация обработки и анализа исходных данных

NEW! Отдельное новое направление: данное направление предназначено для решения задач в случаях, когда необходимо производить какие-либо сложные операции над документами в целом и их контентом в частности или имеется огромный объем исходных данных, который также нецелесообразно анализировать в ручном режиме и требуется автоматизация.

☑ Да, мы можем всё автоматизировать в любом виде и формате.

Подробнее про автоматизацию обработки и анализа исходных данных в отдельной статье ➡️ 

Вопросы безопасности и конфиденциальности

Достаточно часто приходится решать смежные вопросы, связанные как с конфиденциальностью: например, произвести обфускацию контента для возможности публикации или передачи партнерам. Другая ситуация: требуется подготовить “пакет документов по безопасности” в соответствии с регламентами ФСТЭК/ФСБ. Также данное направление частично пересекается с основным направлением: например, у нас есть проверенные и отточенные методики формирования и согласования документов под грифом “конфиденциально” и выше, включая ряд технологий, в случае применения которых можно не переживать за конфиденциальность чувствительной информации.

☑ Мы проведем анализ и обфускацию ваших текущих документов, а также в случае необходимости предоставим иные услуги в сфере безопасности и конфиденциальности.

Работают отдельные специалисты: запросить возможность оказания услуги  ➡️ 

Оформить заказ на разработку технической документации прямо сейчас