Документы и поиск

Как перенести документацию проекта и связать её в граф

Перенос из Notion и папки заметок в Markdown, ссылки двойными скобками, обратные связи, версии на каждую правку и возврат к предыдущей одним нажатием.

Александр ЦапковОбновлено 11 сентября 20262 мин

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

Шаг 1. Перенесите накопленное

Библиотека → «Перенести из другого сервиса».

Подходит:

  • выгрузка Notion в формате «Markdown & CSV»;
  • любая папка заметок в Markdown, в том числе хранилище Obsidian — дерево папок, ссылки двойными скобками и вложения сохраняются;
  • отдельный архив документов папкой.

После переноса приходит отчёт о деградациях: что перенеслось как есть, а что пришлось упростить. Читать его стоит — там видно, какие связи не восстановились и какие блоки исходного сервиса не имеют аналога.

Шаг 2. Создайте документ

В «Библиотеке» — «Новый документ», либо возьмите шаблон: техспека, заметки встречи, ретроспектива.

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

Шаг 3. Свяжите документы между собой

Наберите [[ и название документа — появится ссылка.

Дальше происходит главное: у документа, на который сослались, появляется обратная ссылка, а на графе — линия. Через полгода вопрос «а где мы это решили» решается не поиском по словам, а переходом по связям от того документа, который вы помните.

Шаг 4. Пишите как привыкли

Markdown, таблицы, формулы, диаграммы и картинки. Оглавление собирается из заголовков само.

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

Шаг 5. Обсуждайте и возвращайтесь назад

Комментарий оставляется к абзацу, а не к документу целиком — обсуждение не теряет предмет.

«История версий» показывает, кто и что менял. «К предыдущей версии» — откат одним нажатием, без разбирательства, какая правка была лишней.

Что это меняет в работе с заказчиком

Из документов библиотеки собирается витрина проекта: выбранные документы, разложенные по разделам, открываются заказчику на адресе проекта. Заказчик видит то, что вы выбрали, и не попадает в рабочее пространство.

Как это устроено — Клиентский портал.

Рядом с этим

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

Автор

Александр ЦапковОснователь Скоупворк

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