[golos wiki] Краткий отчёт и предложения

Принятые изменения

С момента прошлой статьи о запуске инициативы по наполнению wiki было принято 2 pull request-а:

• https://github.com/GolosChain/wiki/pull/22, diff - добавление статьи о ролях нод - по сути это фиксация материала из моей статьи Типы нод.
• https://github.com/GolosChain/wiki/pull/26, diff - небольшие правки касаемые инструмента gitbook

Дальнейшие планы по wiki

Перед тем как что-либо делать дальше, считаю необходимым собственно обсудить планы. Нет смысла начитать работу без уверенности, что она будет принята.

В общем, мною было поднято ряд проблем и предложений:

• Файлы в проекте, которых тут быть не должно - выпилить из проекта "левые" файлы. Зачем нам в git-е всякие google-site-verification: googleb3f5140b95eb7267.html ?
• Привести файловую структуру проекта в соответствие со структурой оглавления. Я обнаружил, что структура файлов wiki никак не соответствует структуре оглавления. Оглавление одно, а файлы статей разбросаны в директориях проекта как попало, часть статей просто в корне проекта.
• Распилить раздел "Разработчикам". Раздел "Разработчикам" разросся и включает в себя кучу всего. Тут и устновка golosd, и API, и часть описания логики блокчейна, и прочее. Этот раздел явно просится на распил на подразделы:
  • то, что связано с настройкой и запуском golosd
  • разработка приложений для блокчейна
  • разработка самого golosd
• Нужна тотальная реорганизация wiki. Про это дальше, отдельно.

Реорганизация

Мои предложения по реорганизации, которые хотелось бы обсудить:

1. Прекратить практику прямого копипаста. Это очень порочная практика. Берутся статьи с Голоса и прямым копипастом постятся в wiki. ЗАЧЕМ? Можно просто тогда уж поставить ссылку. Такие статьи протухают и править их страшенный геморрой. Проще переписать с нуля.
2. Переписать статьи таким образом, чтобы они не были написаны от первого лица. Избавиться таким образом от п. 1.
3. Пересмотреть оглавление, не допускать дублирования одной и той же темы в разных статьях. Часто сталкивался с тем, что инфа по одной теме размазана по нескольким статьям. Когда надо что-то перечитать, сидишь и тыкаешься в оглавление в поисках "той самой" статьи, которая содержит нужное. Помнишь, что читал, а в которой из статей - нет!
4. Всё тухлое перенести в отдельный раздел "протухло" чтобы старьё не мозолило глаза и не пересекалось с актуальными данными. Лучше меньше, да лучше. Это изменение позволит чётко видеть, что актуально, а что нет.

Реструктуризация

Считаю, что текущее оглавление

• АКТУАЛЬНОЕ
• НОВИЧКАМ
• ЭКОНОМИКА
• ДОКУМЕНТЫ
• ...

какое-то странное и с ним что-то не то. Хочется его переделать, но вот как именно, пока не придумал. Когда я задумался о распиле раздела "Разработчикам", возникла мысль, что в текущее оглавление моя идея не вписывается. Нужна другая структура, более логичная и чёткая. Грубое представление пока такое:

• FAQ
• Описание платформы - тут описание экономики, всё что нужно для пользователя
• Клиенты - тут пользовательская документация по интерфейсам и т.п.
  • Руководство пользователя golos.io
  • Руководство пользователя goldvoice.club
• ПО голоса
  • golosd
    • установка, настройка, запуск, running and operating - по сути, администрирование
    • подраздел для разработчиков ПО на базе блокчейна
      • API
  • Скрипты
    • скрипты для делегатов
  • Боты для telegram
    • golos notify
    • стопицот ботов vik-а
• Жизнь на площадке
  • Описание тэгов
  • Что такое psk, vox-populi и прочие непонятные штуки
  • Программа 50/50

Заключение

1. Сопровождение wiki, как и golosd ведётся не публично. Пора менять этот подход и начать публично договариваться о дальнейших планах, чтобы никто не прикладывал усилия впустую.
2. community пора перестать надеяться на @cyberfund, "ждать ХардФорков" и начинать двигать платформу самостоятельно. Про это надо написать отдельно.