diff options
Diffstat (limited to '.README.md')
| -rw-r--r-- | .README.md | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/.README.md b/.README.md new file mode 100644 index 0000000..5bfcad8 --- /dev/null +++ b/.README.md @@ -0,0 +1,121 @@ +# Mynd + +## Идея + +Это хранилище направлено на сохранение всех идей и мыслей, что возникают в моей голове. + +## Предыстория + +В течение долгого времени я страдал проблемой забывания собственных идей и мыслей. На то были +попытки сделать свою собственную реализацию хранилища, далее попытки использовать Obsidian. + +К сожалению, каждый из экспериментов ведения хранилищ до этого проваливался, так как я превращал его +в личный дневник, который далее вести не хотел вообще. + +По этой причине это хранилище отныне является полной свалкой, которую я пытаюсь хоть как-то +систематизировать. + +## Принципы + +Для сохранения этого хранилища на долгое время, приняты следующие принципы ведения хранилища знаний: + +1. Создаваемые заметки должны быть настолько мелкими, насколько это возможно. + > [!TIP] + > Если мысль содержит несколько маленьких мыслей, их необходимо разбить на несколько заметок (и + > при необходимости связать их между собой). + +2. Создаваемые заметки обязательно должны иметь ссылку на другую заметку. + > [!NOTE] + > Это правило разрешено нарушать лишь определённым заметкам, роль которых в группировке заметок + > между собой. + +3. Создаваемые заметки должны иметь отметку о том, что её необходимо отсмотреть в конце дня, для + качественного отбора заметок. + +4. Удалять заметки запрещено. + > [!TIP] + > Если хочется, чтобы заметка не появлялась в поисках, можно дать ей какой-нибудь тег для + > отфильтровки + +## Релизация + +Для реализации этого хранилища используется проект `zk`, который позволяет управлять файлами +Markdown как хранилищем. + +1. Имена файлов заметок будут генерироваться рандомно и будут иметь формат 8 alphanumeric символов. + Это позволит избавиться от ненужной зависимости "название файла - содержимое". + > [!TIP] + > Указанная реализация хранилища позволяет искать содержимое внутри карточек, что убирает + > необходимость в "удобных именах файлов". К тому же фиксированная длина файловых имён позволяет + > ссылаться на них удобнее. + +2. В начале каждой заметки генерируется Frontmatter, внутри которого заданы ID карточки и дата + создания. Это позволяет сохранить данные о карточке в момент её создания, не опираясь на + файловую систему. + +3. Каждая новосозданная заметка имеет тег #draft, который позволяет зафиксировать, что эту + карточку необходимо отсмотреть. + +4. Каждая новосозданная заметка имеет ссылку на родительскую заметку. Родительская заметка, в свою + очередь тоже должна иметь ссылку на дочернюю заметку. Таким образом создаётся система + двухнаправленных связей, где к каждой заметке можно попасть с помощью прямых переходов по + ссылкам. + > [!TIP] + > В момент создания заметка может не иметь ссылку на себя, и тогда с помощью `zk` можно + > определить, что она является "сиротой". + + > [!NOTE] + > Одно из условий выхода заметки из #review - заметка не является "сиротой". Это гарантирует, + > что карточка не затеряется среди массы связей. + +### Перечень тегов + +- `draft` - заметка является черновиком. Тег снимается с заметки, когда она является законченой. +- `dead` - заметка, которую я отныне считаю бесполезной. + +- `book` - заметка является ссылкой на книгу. +- `podcast` - заметка является ссылкой на подкаст. +- `video` - заметка является ссылкой на видеоматериал. + +- `snippet` - заметка содержит в себе код, который полезен для раскрытия мысли. С таких заметок + снимается ограничение на количество слов, вследствие наличия кода. Однако рекомендуется сохранять + минимальность каждой заметки. + +- Идейные заметки - используются для высказывания идейный мыслей в моей голове. Подразумевается + использование для сохранения проектов, мысль о которых возникла в голове. + - `huge idea` - заметка является масштабной идеей. Масштабность её заключается в том, что вся + задумка не может быть высказана в рамках одной заметки. + Масштабная идея обязана иметь ссылки на связанные малые идеи. + Масштабная идея также подразумевается как глобальная мысль, которая не имеет родителя. + + - `tiny idea` - заметка является малой идеей. Может являться как частью масштабной идеи, так и + самодостаточной идеей. + +- Информационные заметки: + - `knowledge` - заметка содержит в себе информацию, которая считается мною как факт, но взята из + моей памяти. Создаётся для сохранения мыслительного процесса, с упором на мои знания. + Обязана иметь backlink на идейную заметку. + Не должна иметь прямые ссылки на заметки, за исключением продолжения мысли. + + - `reference` - заметка содержит в себе информацию, которая считается другим человеком как факт. + Является ссылкой на чью-то работу. Может быть ссылкой на книгу, видео или что-то другое. + Обязана иметь backlink на идейную заметку. + Не должна иметь прямые ссылки на заметки, за исключением продолжения мысли. + > [!NOTE] + > Только этому виду заметок разрешено иметь ссылки на источники вне хранилища. + +- Переосмысленные заметки: + - `rethought` - заметка содержит в себе переосмысление информации, которая считается мною или + другим человеком как факт. + Обязана иметь backlink на информационную заметку. + +- Синтезированные заметки: + - `invention` - заметка содержит в себе реализацию идеи/информации/переосмысления. Иными + словами, эта заметка - продукт моих стараний, без упора в результат чужой работы. + +#### Иерархия тегов +- `huge idea` +- `tiny idea` +- `invention` +- `rethought` +- `knowledge`, `reference` |