Как стать автором
Обновить
76.47

Подготовка технической документации *

Всё о деятельности технических писателей

Сначала показывать
Порог рейтинга
Уровень сложности

State & Transition Diagram — что это и как применять

Время на прочтение9 мин
Количество просмотров134K

State & Transition Diagramm (сокращенно S&T) — схема состояний и переходов. Техника для визуализации ТЗ. Она наглядно показывает, как некий объект переходит из одного состояния в другое.

Вот объект находился в состоянии А, потом произошло какое-то действие, и он попал в состояние В. Потом он попадет в состояние С и другие... Принцип не меняется, было одно состояние, стало другое.

Читать далее

Хорошие BPM — инструменты, которых нет и нет. Моделирование процессов

Время на прочтение15 мин
Количество просмотров20K

Поговорим о том, какие инструменты хотелось бы иметь при описании бизнес-процессов. Инструментов BPMS (BPM systems) много, но выбрать то особо нечего …  

Ниже перечислим некоторые важные инструментальные возможности некоторых сред моделирования процессов (в основном ARIS и MS visio).

Читать далее

Decision Table — что это и как применять

Время на прочтение5 мин
Количество просмотров147K

Decision Table (таблица решений) — техника, помогающая наглядно изобразить комбинатору условий из ТЗ.

Чем проще и понятнее требования, тем меньше будет разночтений. И тем меньше исправлений после реализации. И тем проще нам, тестировщикам, писать тест-кейсы по таким требованиям.

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

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

Читать далее

О роли системного аналитика и шаблон для проектирования

Время на прочтение7 мин
Количество просмотров70K

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

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

Разработчику с проектированием и документированием решения задачи помогает аналитик.

Строить дом и строить систему. Что общего?

Чек-лист тестирования требований

Время на прочтение7 мин
Количество просмотров161K

Когда разрабатывается новый функционал, аналитик пишет требования, а тестировщик их проверяет. До того, как начать реализацию. Потому что на этом этапе внести исправления дешевле всего.

Вот только на что обращать внимание при тестировании? Есть набор основных характеристик, которыми должна обладать хорошая документация:

Читать далее

Интернет-магазин. Создание, набитые шишки и полезные выводы

Время на прочтение6 мин
Количество просмотров10K

Наверняка многие, желая создать интернет-магазин, сталкивались с вопросами. Выгодно ли? Насколько трудно создать? Сколько стоит? Какие подводные камни? Давайте попробуем разобраться.

Читать далее

Какая бывает документация

Время на прочтение24 мин
Количество просмотров48K

Когда мы говорим о тестировании документации, то обычно подразумеваем тестирование требований, ТЗ. И это тестирование на полносту, однозначность и прочая. Смотрим, как новый функционал будет коррелировать со старым, не будет ли проблем. Заранее продумываем свои тесты, обсуждаем реализацию...

Однако помимо ТЗ есть еще куча другой документации, которую тоже стоит проверить. Как минимум вычитать, нет ли ошибок. Давайте посмотрим, какая бывает документация:

Читать далее

Требования от системного аналитика и шаблоны документации

Время на прочтение4 мин
Количество просмотров40K

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

 Я стараюсь придерживаться позиции, что это сугубо индивидуально и зависит от команды и кому как комфортно работать. Случается, что разработчикам достаточно use-case  для того, чтобы сделать дизайн, а тестировщикам этого достаточно, чтобы написать тест-кейсы. Поэтому я буду писать о тех артефактах, которые могут возникнуть при написании требований и о которых надо точно задуматься к моменту завершения разработки, а вы сами решайте и договаривайтесь внутри команды, когда это стоит описывать. Однозначно только, что к концу разработки документация должна содержать все то, о чем далее пойдет речь.

Читать далее

«Мистер X» или стоит ли небольшой команде рассмотреть XWiki как возможную замену Confluence?

Время на прочтение5 мин
Количество просмотров25K

В феврале 2021 Atlassian прекращает продажу лицензий на серверные версии Confluence. В этой статье я поделюсь своим виденьем Xwiki в качестве аналога Confluence, закрывающего потребности по документированию для небольшой команды разработчиков.

Читать далее

Docs as Code. Часть 2: получаем документацию из кода

Время на прочтение10 мин
Количество просмотров13K


Продолжаем рассказывать о применении на практике принципа работы с документацией как с кодом. В этот раз разберём получение спецификации Swagger напрямую из комментариев к коду API. В статье рассматривается роль технического писателя в процессе адаптации команды к использованию нового инструмента, а также приводятся конкретные инструкции по применению swagger-php в реальном проекте.
Читать дальше →

5 диаграмм, необходимых для документирования архитектуры решений

Время на прочтение8 мин
Количество просмотров93K

Процесс документирования архитектуры программного обеспечения может показаться пугающим. Но на самом деле достаточно всего 5 диаграмм, чтобы объяснить структуру вашей системы практически любому. 

Читать далее

Как мы снимаем видеоинструкции для решений Рутокен

Время на прочтение11 мин
Количество просмотров4.1K

Мы решили продолжить наш цикл статей про разработку пользовательской документации, но на этот раз нам захотелось рассказать об еще одном способе создания инструкций для пользователей — это съемка видеороликов. Мы расскажем о процессе их производства: от возникновения идеи до загрузки ролика на YouTube-канал. У нас нет студии и профессиональных актеров, мы все делаем сами и хотим показать вам, что это не так сложно. Здесь вы найдете: идеи, готовые алгоритмы и, быть может, вдохновитесь на съемку своей видеоинструкции.

Вдохновляйтесь

Момент, когда проектная документация нужна

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

Но это ерунда. Хуже, когда заказчик говорит: «Создали два разработчика. Уволить не могу, хотя почти ничего не делают, только по мелочи донастраивают. А с этой системой у нас уже и бухгалтерия интегрирована, и … Документация? Нет ее. А надо?.. Спасите-помогите»!

Проблемы с документацией в процессе разработки ПО были, есть и будут. Эта статья посвящена поиску момента, в который появляется необходимость ведения проектной документации и поможет принять решение, если у вас только начали появляться мысли об этом. Повествование сопровождается примерами из жизни МоегоСклада.


Читать дальше →

Ближайшие события

Manipulation Process Efficiency (MPE) Benchmark

Время на прочтение14 мин
Количество просмотров1.3K

Бенчмарк для технологии манипуляции


Бенчмарк предназначен для оценки эффективности применения робототехнического комплекса (РТК) в задачах манипуляции предметами по сравнению с использованием ручного человеческого труда.

Бенчмарк содержит следующий набор метрик(коэффициентов):

ωaKa — взвешенный коэффициент автономности,
ωlKl — взвешенный коэффициент времени обучения выполнению задачи,
ωwKw — взвешенный коэффициент грузоподъемности,
ωcKc — взвешенный коэффициент коллизионности рабочей сцены,
ωdKd — взвешенный коэффициент тяжелых условий труда,
ωpKp — взвешенный коэффициент брака,
ωoKo — взвешенный коэффициент среднедневной нормы выполнения атомарной операции,
ωeKe — взвешенный коэффициент энтропии.

Обобщенная формула вычисления бенчмарка:
image
Где ωi Ki – взвешенный коэффициент из набора метрик.

Каждая метрика рассматривает характеристику применения робототехнического комплекса по отношению к аналогичной характеристике в случае применения ручного труда и является безразмерной. Значение каждой метрики интерпретируется по отношению к человеку:

  • если значение меньше единицы, то применение РТК для измеряемой задачи обладает меньшей эффективностью по сравнению с использованием человеческого труда.
  • если больше единицы, то применение РТК более эффективно по отношению к использованию ручного труда.
Читать дальше →

Manipulation Process Efficiency (MPE) Benchmark

Время на прочтение1 мин
Количество просмотров453

Бенчмарк эффективности решения задач манипуляции предметами (MPE)

Назначение: Бенчмарк предназначен для оценки эффективности применения робототехнического комплекса в практических задачах манипуляции предметами по сравнению с другими системами автоматизации (в т.ч. роботизации) или использованием ручного человеческого труда.

Разработано: Лаборатория робототехники Сбера

Внимание! Если вы перешли сюда по ссылке из поисковой системы!

Корректная ссылка на статью: https://habr.com/ru/post/534954/

Читать далее

Тернистый путь стандартизации блокчейн технологий в России

Время на прочтение10 мин
Количество просмотров3.3K

Блокчейн технологии переживают очередной ренессанс на фоне роста криптовалютного рынка и развития инициатив стейблкоинов и CBDC. Можно сказать, что это два отдельных мира. В одном блокчейн является основой для построения нерегулируемой криптоэкономики, в другом блокчейн как технология для создания новых регулируемых бизнес-процессов. 

Что может объединить эти два мира? Ответ: диалог экспертов этих двух миров (криптоэкономического и корпоративного) по вопросам стандартизации технологический и лучших практик, а также принятие общих технологических подходов. Такой диалог потенциально сможет упростить последующие интеграционные процессы и ускорить принятие блокчейн-технологий широкими массами.

Но как этого достичь? В коммерческой среде, когда нужно наладить взаимодействие участников какого-либо сектора экономики, создаются ассоциации и консорциумы. В чисто технологических вопросах такими площадками выступают центры стандартизации, например МСЭ-Т(ITU-T), ИСО (Международная организация по стандартизации). В России такой независимой площадкой объединения экспертов блокчейн-технологий выступает Технический Комитет по стандартизации "Программно-аппаратные средства технологий распределённого реестра и блокчейн" (http://bccmt.ru).

Как руководитель одной из рабочих групп (с декабря 2019 года) и эксперт ISO TC 307 DLT (TC 307 - Blockchain and distributed ledger technologies) я хочу поделиться информацией по стандартизации блокчейн технологий в России и мире. А также привлечь внимание экспертов блокчейн рынка к работе ТК 159, как площадке взаимодействия, которая может многое дать своим участникам.

Узнать больше

Генератор диаграмм таблиц ClickHouse для PlantUML

Время на прочтение4 мин
Количество просмотров5.1K

Когда появляется необходимость документировать схемы баз данных, разные DBMS предоставляют свои инструменты для подобных задач. И большинство из них поддерживает DESC table_name, в том числе и ClickHouse. Однако, результат этой команды не столь выразителен, как хотелось бы.


DESCRIBE TABLE data_lr

name        type      default_type   default_expression   comment   codec_expression   ttl_expression
Path        String                                                  ZSTD(3)
Value       Float64                                                 Gorilla, LZ4
Time        UInt32                                                  DoubleDelta, LZ4
Date        Date                                                    DoubleDelta, LZ4
Timestamp   UInt32                                                  DoubleDelta, LZ4

При этом, системные таблицы tables и columns содержат исчерпывающую информацию, объединив которую, можно получить вот такой симпатичный результат:


Читать дальше →

Как сделать текст легче

Время на прочтение6 мин
Количество просмотров5.5K

В прошлой статье я обещала, что расскажу, как сделать документы легче для восприятия. Есть два основных направления: текстовка и структура документа. Сегодня поработаем с текстами. Технические документы на русском читаются особенно тяжело, и добиться легкости в них сложнее, чем в английском. Как можно исправить многословные, громоздкие документы? Давайте попробуем сделать их конкретнее, проще, короче, и последовательнее.

Читать дальше →

Такие разные документы: конструкторские vs. user-oriented

Время на прочтение3 мин
Количество просмотров2.3K
Моим любимым русским техническим писателям посвящается

Работа технического писателя – создавать документы на программные продукты, в основном всевозможные руководства пользователя. Разработка документа – дело непростое. Есть очень много подходов и практик. Например, технические писатели в научно-производственных предприятиях часто пишут по ГОСТам или другим отечественным стандартам. Их цель – точно и верно описать продукт. А technical writers в международных компаниях пишут по style guides (Microsoft Manual of Style, например). В этом случае цель, скорее, донести до пользователя, как продукт работает. Здесь фокус смещен с продукта на читателя.

Мне довелось побыть техническим писателем в разных местах, с разными правилами и политиками. Оглядываясь назад, могу сказать, что даже в НИИ тексты можно переориентировать на конечного пользователя, и документы от этого выиграют. Но в ГОСТах про это не пишут. А style guides, во-первых, на английском, а во-вторых, не афишируются в отечественных конторах типа НПП, КБ, и пр. Поэтому есть явная нехватка информации. Я попробую ее восполнить.
Читать дальше →

Рабочие места Selectel: тестировщик интерфейсов, технический писатель, менеджер продуктов, тестировщик и редакторы

Время на прочтение11 мин
Количество просмотров11K

Привет, Хабр! Сегодняшняя статья целиком посвящена рабочим местам и уголкам для хобби сотрудников Selectel. Всегда было интересно читать похожие посты других компаний, включая сам Habr. И мы решили поделиться своей историей. Если у вас будут вопросы, задавайте в комментариях, ответим. Кстати, если есть желание, хвастайтесь в комментариях своими рабочими местами, хобби или DIY-проектами.
Читать дальше →