Документация

Что я вижу, когда анализ попал в проект?

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

Короткий ответ

Проект открывается рабочим пространством: карта системы, реестр её интерфейсов и каталог компонентов, а рядом с выбранным объектом его назначение, операции и доказательства. Каждое утверждение показывает, где оно найдено. То, чего никто не установил, перечислено как открытый вопрос, а не заполнено догадкой. Одно число говорит, насколько система изучена и как это посчитано. После второго анализа раздел изменений и сводка показывают, что сдвинулось, отдельно от того, что только узнали или переформулировали. Всё это можно забрать одним файлом Markdown.

#Рабочее пространство

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

  • Карта. Компоненты и интерфейсы между ними, внешние сервисы по краям. Большая система открывается подсистемами, сгруппированными по той вложенности, которую записал анализ, и никогда не угаданной по названиям или папкам. Каждая группа говорит, сколько в ней объектов и связей, и раскрывается по запросу.
  • Реестр интерфейсов. Одна запись на логический интерфейс, операции внутри неё: что что вызывает, по какому протоколу и по какому адресу, если он известен. Отсутствующий маршрут показан как отсутствующий.
  • Компоненты. Каталог всего, что нашёл анализ, с поиском, с назначением и жизненным циклом каждого компонента.

Инспектор рядом с видами показывает выбранный объект: зачем он, его операции, доказательства и открытые вопросы о нём. Объёмный вид той же карты включается одним переключателем и нужен, чтобы пройти запрос уровень за уровнем. Он рисует те же записанные факты и не выдумывает никакого трафика.

#Доказательство под каждым утверждением

Утверждение в проекте никогда не бывает свободным абзацем. В нём названо, о чём оно, какое свойство описывает, какое значение и где это установлено, вплоть до файла и строк, если анализ их записал.

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

#Что неизвестно

То, что анализ не смог установить, не заполняется. Оно становится открытым вопросом с причиной, по которой он открыт, и с его важностью, и перечислено на отдельной странице. На часть вопросов ответит следующий анализ. На часть может ответить только человек, и страница говорит, на какие.

Та же честность касается охвата. Каждый анализ записывает своё покрытие, то есть что проверено полностью, частично или не проверялось вовсе, и проект никогда не принимает непроверенную часть системы за пустую.

#Насколько система изучена

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

Это число измеряет картину, а не ставит оценку системе. Код отвечает не на всё, и оставшиеся вопросы стоят на странице как вопросы к человеку, а не обещаны к закрытию.

#Что изменилось

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

Что-то объявляется исчезнувшим, только если более новый анализ смотрел на место, где оно было. В остальных случаях это становится вопросом. А утверждение, которое прежний анализ подтверждал, а текущий больше не подтверждает, помечается как больше не подтверждённое, с датой, когда его подтверждали в последний раз.

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

#Сводка

У каждого принятого анализа есть сводка, то есть короткая пронумерованная повестка для разговора с тем, кто делает систему.

  1. Что изменилось в системе

    Структурные изменения этого анализа с тем, что было до и стало после.

  2. Что узнали

    Факты, найденные впервые, но верные и раньше, отдельно от изменений.

  3. Что ещё открыто

    Текущие открытые вопросы в порядке записанной для них важности.

  4. Куда смотреть дальше

    Одна область для следующего анализа с причиной, по которой её предложили. Выбирает владелец.

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

#Как забрать знания

То, что знает проект, можно скачать со страницы проекта одним файлом Markdown, который открывает любой редактор. В нём сказано, какой анализ он отражает и что этот анализ смотрел, насколько система изучена, из чего она состоит, что с чем связано, где оседают данные, что рискованно и чего никто не установил, а заканчивается он разделом о том, чего в файле нет. Это одна кнопка, без выбора формата и без ожидания, и проект записывает, кто и когда взял копию.

Прочитайте готовый проект до того, как анализировать свой.

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

Создать аккаунт Открыть демонстрацию