Решения

Мы предоставляем целый спектр решений и услуг в нашей области – схематично это можно представить следующим образом:

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

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

Средний бизнес

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

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

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

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

С какими форматами документации мы работаем?
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! Отдельное новое направление: данное направление предназначено для решения задач в случаях, когда необходимо производить какие-либо сложные операции над документацией в автоматизированном режиме или имеется огромный объем исходных данных, который также нецелесообразно анализировать в ручном режиме.

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

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

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

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

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

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

Малый бизнес

Разработка отдельных видов документов под ключ
Оформление документации по различным стандартам
Консультирование по созданию документации

Разработка отдельных видов документов под ключ

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

☑ Мы сделаем для вас любой документ “под ключ”.

Хотите увидеть реальные примеры наших работы? Ознакомьтесь с нашим портфолио ➡ 

Оформление документации по различным стандартам

Классическая ситуация: у вас уже имеется разработанная документация, но её необходимо привести к требуемому стандарту (например, ГОСТ 34 или ГОСТ 19). В таком случае мы также можем это сделать, но сразу же стоит отметить: ГОСТы подразумевают требования не только к оформлению, но и к содержанию технической документации – это означает, что нам всё равно придётся продолжить разработку текущей документации в плане дополнений, а в некоторых случаях иногда проще разработать документацию заново, взяв из текущей документации только исходные данные.

☑ Приведем вашу документацию к любому стандарту.

Хотите разобраться во всем самостоятельно? Все стандарты в открытом доступе ➡ 

Консультирование по созданию документации

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

☑ Мы предоставим вам консультацию и ответим на все интересующие вопросы.

Почему вам стоит обратиться именно к нам? Ознакомьтесь с нашей миссией  ➡ 

Большой бизнес

Документирование сложных программных систем
Подготовка документов для сдачи гос. органам
Разрешение различных конфликтных ситуаций

Документирование сложных программных систем

В некоторых случаях приходится производить многоуровневое документирование действительно сложных автоматизированных систем: например, автоматизированных систем государственного уровня с приставкой “Единая Система”. Здесь требуется определенная профессиональная квалификация и значительный опыт.

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

Напишите нам и мы всё обсудим в индивидуальном порядке  ➡ 

Подготовка документов для сдачи гос. органам

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

☑ Мы подготовим полный комплект документации “под ключ”, готовый к сдаче госзаказчику.

Ознакомьтесь со списком наших крупнейших клиентов ➡ 

Разрешение различных конфликтных ситуаций

Иногда случается так: проект и документация готовы, но сдача-приемка ведомству всё никак не происходит, а штрафы по госконтракту тем временем уже начали капать и только набирают обороты. И вам необходима квалифицированная помощь в решении этого деликатного вопроса.

☑ Поможем и здесь. Мы решим любые вопросы.

Заинтересовало? Сохраните презентацию нашей компании в формате PDF (1МБ) ➡ 

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