Черновик системы документации

Карта
документации

Документация MUAR нужна не для хранения файлов. Она должна отвечать: что уже решено, что сейчас проверяем и какое решение понадобится дальше.

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

Сначала смысл, потом документ

На обложке будут не названия файлов, а три понятных направления: Решения, Вопросы и исследования и Идеи на будущее. Внутри каждого направления — ссылки на конкретные страницы.

Четыре слоя

Где живёт каждая мысль

1. Решения

Только то, что ты подтвердил. Источник — «Чистое ядро». Любое решение получает дату и, когда нужно, ссылку на исследование, из которого оно выросло.

2. Вопросы и исследования

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

3. Идеи на будущее

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

4. Архив

Старые версии и исходные заметки. Они сохраняют историю, но не участвуют в текущих решениях и не должны мешать чтению.

Один маршрут

Как идея становится решением

Идея

Появляется как гипотеза: она интересна, но ещё не обещание продукта.

Вопрос

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

Исследование

Собираем факты и референсы, показываем 2–3 варианта с последствиями, даём рекомендацию.

Твой выбор

Только когда варианты готовы. Никаких вопросов, где тебе предлагают самому придумывать устройство системы.

Решение

После подтверждения запись попадает в ядро. Исследование остаётся рядом как объяснение, а не исчезает.

Следующий этап

Что делаем сейчас

1. Наводим порядок в поверхности

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

2. Затем заполняем систему

После этого переносим в «Идеи на будущее» уже собранные гипотезы и постепенно превращаем важные из них в вопросы для исследования.