Skip to content

Latest commit

 

History

History
194 lines (163 loc) · 18.2 KB

notes.md

File metadata and controls

194 lines (163 loc) · 18.2 KB

заметки

общая цель этих заметок, привести к решению задачи по написанию документации. '*' в начале пункта чек бокса означает что задача активна

после выполнения заметки (если она связана непосредственно с работой в документации) сразу же делайте пуш

тут как и с системой scheme#АГРЕГАЦИЯ, будет применён тот же метод для релизов. данный релиз является первым

что бы не путаться при git pull, описание на слиянии просто: "merge: with konard". все изменения запишет сам участник

FRAME:

работа со структурой. создание файлов, переименование, работа с переносом блоков текста

  • разработать первую страницу документации README
  • задать gitignore что бы не учитывать в коммитах лишние файлы
  • разработать подход преобразования статей в общую документацию
  • разработан temp для временной информации
  • разработан scheme для описания принципов работы с документацией
  • разработана awareness для описания принципов работы scheme
  • принципы осознания были убраны по причине сильного усложнения документации, её принципы частично и так раскрыты в других блоках, может быть позже вернем
  • разработана страница git для описания основной работы с git
  • создан relise что бы отделить временную и общую информацию в readme
  • syntax были разработаны стандартные блоки
  • переосмысление схемы, введение системы достижений
  • добавление задумки и примера процедурно генерируемого содержания
  • создание страницы examples для тестирования корректной работы синтаксиса
  • первое описание и разработка community
  • переработка системы достижений в систему заметок, теперь это проще, добавлена страница notes
  • разработка issues для того что бы люди могли найти решение или обратится с проблемой
  • перенос документации из wiki в корень автора freephoenix888
  • добавление отдельной страницы standarts для облегчения схемы
  • убрана awareness по причинам высокой нагрузки по разработку основной документации, основные принципы и так находятся на конечных страницах
  • убрать страницу temp и переработать её в постоянную страницу archieve задав немного другую функцию
  • убрать conections и dictionary так как в ближайшее время процедурно генерируемые элементы недоступны
  • было изменено расположение gpt4-prompts_to_use-deep на drakonard так как сделано им
  • была создана папка general для агрегирования всей доступной документации
  • переработка блока материала и инструментов в материалы в scheme
  • переработка readme под блок общих адаптированных материалов, пока нет общей документации
  • добавлена первая страница общей документации introduction.md
  • перенос документации ivansglazunov из notion: install on windows
  • перенос документации ivansglazunov из notion: install on linux
  • перенос документации ivansglazunov из notion: install on macos
  • перенос документации ivansglazunov из notion: install on gitpod
  • перенос документации ivansglazunov из notion: install on runkit
  • перенос документации ivansglazunov из notion: guides
  • перенос документации ivansglazunov из notion: deep.links
  • перенос документации ivansglazunov из notion: deep.case
  • перенос документации ivansglazunov из notion: deep.micro
  • перенос документации ivansglazunov из notion: deep.memo
  • перенос документации ivansglazunov из notion: packages

AGGREGATION

объединение или переработка статей для общей документации

  • объединены статьи install-os и install-docker-os

TRANSLATE

перевод статей взятых со сторонних источников на русский

  • install-windows
  • install-linux
  • install-macos
  • install-gitpod_env
  • install-runkit_terminal
  • промежуточные статьи не учитываются (как списки других статей)

WRITE:

написание продолжения, расширение существующего, как правило без изменения старого

  • написание первого readme
  • базовое описание работы с git
  • базовое описание scheme для работы с этим проектам по принципам осознания
  • задание целей документации
  • задание материалов и инструментов документации
  • описание принципов работы достижений
  • описание принципов работы заметок
  • наработка документации по гит, требуются правки
  • перечисление основных статей deep в readme
  • описать текущие доступные материалы по deep в relise и участников
  • описание принципов осознания
  • описание стандартных блоков документации в syntax
  • добавлен блок tags в syntax
  • описание принципов агрегации в scheme
  • описать сложности выполнения задач по доке в scheme
  • описать о базовых принципах работы deep, о работе его ядра, принцип создания всего из одной связи
  • не учитывается написание постов таких как в community

RELISE:

завершённая часть документации со всеми закрытыми заложенными гештальтами

  • community готов к 1 релизу
  • scheme готов к 1 релизу
  • notes готов к 1 релизу
  • syntax готов к 1 релизу
  • standarts готов к 1 релизу
  • git готов к 1 релизу
  • examples готов к 1 релизу
  • issues готов к 1 релизу

FIX:

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

  • исправить начальную страницу документации на список статей, так как сейчас недостаточно ресурсов для реализации общей документации
  • заменить достижения из их сложности в планировании на более простые заметки
  • убрать участников из relise, так как становится сложно учесть кто внес вклад, теперь это будет делаться в community и с остановкой источников на статьи в заголовках
  • исправить речь в доке: "я бы сказал тем больше нами будут пользоваться, или тем больше deep будет полезен людям" от конарда
  • перевод всего под стандарт syntax после его введения
  • исправления синтаксиса не учитываются
  • исправление мелких недочетов не учитываются

TEST:

тестовый коммит для теста фичи или возможностей

  • проверить как работает синтаксис заметок на github
  • проверить работу пушей и получения проекта
  • протестировать работу всех блоков
  • протестировать скрытых блоков
  • тестирование работы блока тегов
  • визуализация отделов, как они работают (схема), перевод язык бизнеса в язык кода, фронтенд для демонстрации (дип выполняет эту функцию), костяк схем и есть документация
  • какие виды проектов существуют и для каких целей, какие пути развития есть
  • доступные функции для проектов, возможности
  • описание пакетов
  • документированность ваших проектов и их предназначение
  • реализовать интерактивное обучение на deep-case
  • сделать общение с читателем через общение на прямую ломая 4 стену и выделить каким то отдельным стилем и добавить к этому окраску оккультизма, так можно разбавить сухую документацию
  • идея геймификации документации персонажами
  • геймификация пакета при помощи персонажа (это может смотивировать к разработке и будет интересно)
  • описать и проверить, неэффективность содержаний (содержания это очень много текста, когда есть возможность указывать источники точечно и они будут выделятся на общем фоне)
  • намеренные "запинки" в тексте. можно использовать тяжелый речевой оборот, что бы человек который читает большой объем информации мог зацепится за важный нюанс взглядом и запомнить из за усложненного его понимания
  • возможно стоит писать заметки в настоящем а не в будущем числе, так как так будет меньше давления на работающих

EXTRA

дополнительная работа косвенно связанная с проектом, как правило не пушится

  • составить issue по излишнему количеству папок которые порождает deep-case
  • дракон код рассмотреть https://habr.com/ru/articles/345320/
  • рассмотреть drow.io
  • описать зону ответственности tand(a) над документацией, что бы было понятно, что за решения и почему были приняты
  • разделить заметки на работу по документации (которые можно пушить) и на работу смежную по deep
  • перенести статьи awareness в кадет форум
  • продолжить развитие achievements
  • issue по не удалению данных пользователя после удаления deepcase-app
  • issue по ошибке прав доступа (видно пространство админа, когда ты юзер)
  • перенести пакет uppertext из gitpod в deepjson
  • microsoft-visio рассмотреть

  • ПОКА ЧТО НЕ УСПЕЛ ОТСОРТИРОВАТЬ ЗАМЕТКИ ПО НОВЫМ ПРАВИЛАМ

ПОДГОТОВКА

  • расписать принцип работы общей структуры статей
  • составить стандарты составления заметок, связать это со схемой плотнее
  • описать блок в заметках или схеме о том, что сторонние статьи должны проходить не по всем стандартам
  • спросить по поводу examples у freephoenix888 и решить что с ними делать, так же readme
  • переработать readme и схему, описать что целью документации является deep-case (на данный момент)
  • описать страницы перечисления и повествования
  • добавить разноязычность в документацию
  • структурировать заметки в том числе добавить отдел для быстрых заметок, которые в последующем могут быть приведены к стандартам и разложены на равные уровни исполняемости
  • составить список основных ресурсов deep-foundation
  • отметить документацию на основных ресурсах deep-foundation
  • основные понятия для deep-foundation, составить их список, описать в dictionary или другой странице
  • нужно перенести ссылку по вики (https://github.com/deep-foundation/deepcase-app/issues/new?assignees=&labels=bug&projects=&template=BUG_REPORT.yml), попросить это, когда документация будет доработана
  • создать общий список issues и зону ответственности проектов
  • проверить совместимость блоков с deep-case и подредактировать их при надобности и написать парсер
  • проверить все ссылки на работоспособность
  • переработать схему к более простому виду
  • убрать осознание в другой проект, описать все что требуется базовым языком, используя ответственность за документацию как объяснение принятых решений
  • описать в схеме на кого ориентированна документация и на основе этого делать приоритеты
  • описать где то про issue по deep-case и про важность их исполнения. документация должна соответствовать действительности а сам deep-case должен быть защищен от неверных действий, что бы у новичка было чувство контроля а так же желание продолжать изучение и использование
  • описать работу с чек боксами в схеме (о том как пометить выполняемое)
  • после первых
  • проконсультироваться с архитекторами и подготовить список вопросов
  • как создать свой проект в deep-case описание введения
  • добавить краткое описание deep-case в readme что бы люди понимали с чем имеют дело

АДАПТАЦИЯ СТАТЕЙ

  • перенести все что описывал феникс в отдельную папку и сделать ссылку из readme
  • поработать над папкой ивана и адаптировать его документацию
  • разбить по файлам документацию феникса, доработать, перевести
  • переработать доку ивана и описать установку deep-case на сегодняшний день

РЕЛИЗНЫЕ

  • показать документацию её целевой аудитории и собрать фидбек для дальнейшей доработки

ДОПОЛНИТЕЛЬНЫЙ ФУНКЦИОНАЛ

  • автоматизировать процесс создания connections
  • автоматизировать процесс создания dictoanary