💥 Манифест Gramax 💥

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

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

Большие языковые модели, такие как ChatGPT, Claude AI и аналоги, могли бы автоматизировать поиск и пополнение контента. Но если информация разрознена, в ней много противоречий и дублирующихся фрагментов, то LLM только запутается и выдаст неточные или бессмысленные ответы.

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

Это проблема, с которой сталкивается каждый, кто хоть раз пробовал вести совместные проекты, развивать внутренние базы знаний или просто разобраться, «какая версия файла на самом деле финальная».

Два мира

Наблюдая, как человечество работает с текстовой информацией можно заметить, что есть 2 мира:

1. Разработчики, для которых текст — это прежде всего код, конфигурации, техническая документация, и которые привыкли к строгим процессам, вроде контроля версий, ревью, автоматизации и т.д.

2. Более широка аудитория, для кого текст — это статьи, бизнес-документы, письма, посты в соцсетях, сообщения в мессенджерах, отчёты.

В разработке текст (исходный код) воспринимается скорее как фундаментальный ресурс, чем как простое средство коммуникации. Работа с ним строится вокруг строгих правил хранения, версионирования и автоматизации:

• В основе этой культуры лежит система контроля версий, например Git, позволяющая отследить каждое изменение и при необходимости моментально откатить его.

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

• Автоматическое тестирование, проверки форматирования и консистентности кода, освобождают время разработчиков для более творческих аспектов работы.

Вне сферы разработки доминируют классические офисные решения, где текстовые документы создаются и циркулируют в гораздо более свободном формате. Большинство людей полагаются на такие инструменты, как Microsoft Word, Google Docs, Notion, Obsidian.

Тексты публикуются по множеству каналов одновременно: от корпоративных порталов и соцсетей до CMS-систем и офисных приложений. Кто-то пишет в Google Docs, другие — в DOCX-файлах, а кто-то пишет только в почте или мессенджере. Подобная разрозненность создаёт дополнительную сложность при управлении информацией: если в одном месте документ обновили, то на другом ресурсе он может остаться в устаревшем виде.

Вместо строгого контроля версий и автоматизации, которые являются нормой в мире разработчиков, здесь зачастую царит принцип создания одноразовых черновиков, которые устаревают буквально на следующий день. А история изменений ограничивается функцией «Отслеживать правки» или архивами писем с приписками — «v3_финал» у файлов.

Единый источник правды

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

Ограничения на внесение информации

• Проще и быстрее записать информацию в мессенджер или заметки, нежели переходить по ссылкам и искать куда правильно написать.

• Непонятно кто редактировал этот контент и можно ли его редактировать поверх.

• Если сейчас начать вносить изменения, то 100% надо будет исправить ещё несколько мест, а на это необходимо потратить много времени, которого нет.

• Нет информирования об изменениях или когда кто-то хочет предложить изменения.

• Громоздкий интерфейс и множество инструментов для форматирования текста сбивают фокус с сути вносимой информации.

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

• В документе скорее всего написано очень много информации и необходимо всё мучительно изучать.

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

• В базе знаний примитивный поиск и с помощью него можно что-то найти, только если знаешь точные формулировки или примерное расположение документа в базе знаний. Становится проще сразу спросить у того, кто знает ответ.

• Если что-то и будет найдено, то это скорее всего устарело. Опять же, проще сразу спросить у того, кто знает текущее положение дел.

Принципы единого источника правды

Исходя из этого можно выделить ключевые принципы, которые должен поддерживать единый источник правды:

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

• Легкое внесение информации. Внести информацию и поделиться ей должно быть не сложнее, чем написать сообщение в мессенджере.

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

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

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

Практики поддержания единого источника

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

Inbox. Если в систему знаний можно просто и быстро внести информацию, то сильно повышаются шансы на актуальность информации в целом. Когда у вас спросили в мессенджере тот или иной вопрос, то ответ на него необходимо либо сразу внедрить в единый источник, что сложно и требует времени на переключение. Либо сохранить во временную область (inbox) из которой информация будет переноситься в единый источник по расписанию или с помощью LLM. LLM может найти подходящее место в базе знаний для корректировки и создать запрос на слияние, в котором вы будете одним из проверяющих.

Запрос на слияние (Pull/Merge Request). Информация не должна добавляться или изменяться в хранилище без предварительной проверки. Концепция запроса на слияние из мира разработки внедряет коллективный контроль за информацией. Любая правка или новый документ проходят согласование, что гарантирует их качество и соответствие стандартам. Но это не должно осложнить саму механику внесения изменений, иначе это разрушит принцип лёгкости внесения информации.

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

Типизация контента. При пополнении единого источника возникает потребность переиспользования контента в разных документах, категоризации документов для придания им единообразной структуры и более быстрого поиска, добавления мета-информации (дата создания и другие), параметризации слов в тексте для динамической подстановки наименования клиента или компании. Типизация документов и блоков документов позволяет строить динамические представления и динамические документы над единым источником. Например, отобразить инструкции для курьеров, которые не обновлялись больше года.

Gramax — инструмент для создания единого источника

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

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

Принципы Gramax

• Бесплатный навсегда. Все функции для работы с единым источником правды будут всегда доступны в бесплатной версии. Чтобы преимущества единого источника могли использовать не только крупные компании, но и учащиеся, преподаватели, врачи и многие другие.

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

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

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

• Модульная целостность. Gramax содержит все необходимые инструменты для работы с единым источником без переключений между другими приложениями. Все инструменты являются однородными и бесшовно связанны между собой.

• Фокус на внесении изменений. Самое сложное при работе с любой системой — вносить изменения. Gramax максимально облегчает внесение изменений в систему знаний с помощью наглядной подсветки изменений, релевантного поиска необходимых для изменения разделов и автоматизации внесения изменений.