Краудсорсинговая документация

Техническая документация LiveStreet
Пришла идея сделать документацию для разработчиков. Судя по всему, такая необходимость давно назрела. К сожалению, документация быстро устаревает, а бывает и совсем исчезает. Чтобы такого не произошло и её существование не сильно зависело от меня — решил разместить её на GitHub — оттуда уж точно никуда не денется. Надеюсь на вашу помощь в написании.

В общем, вот — livestreet.net

9 комментариев

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

Стандарты написания кода экосистемы LiveStreet
avatar
З.Ы. Вижу, что использованы мои наработки (я не против), но почему все же не комит в существующие репозитории?
avatar
Потому и не стал спрашивать, что лицензия позволяет :)
А что коммитить? Мне кажется они отлично написаны. Я их ещё не дополнял, только добавил немного Markdown-разметки.
avatar
Кстати, во избежание дублирования, наверное можно сделать Ваши наработки субмодулями, входящими в моей репозиторий, если они будут в формате Markdown. К тому же читать их прямо на GitHub'е будет легче.
avatar
Да, документации действительно не хватает. Приходится смотреть чужие плагины и реализовывать аналогично. То, что есть сейчас и то, что нам показали в этом топике, явно не дотягивает до необходимого уровня.

Но мне кажется, что нормальной документации к LS 1.0 мы так и не увидим. Будем ждать 2.0.
avatar
То, что есть сейчас и то, что нам показали в этом топике, явно не дотягивает до необходимого уровня.
Согласен. Поэтому и прошу помощи у сообщества. Мне одному это не потянуть.
avatar
А что конкретно надо сделать?
avatar
Писать документацию. Все тексты размещены на GitHub и их можно редактировать :)
avatar
Начинание хорошее, но проблема подобного краудсорсинга (добавим к этому github.com/psnet/ls-coding-standarts и github.com/psnet/ls-plugins-checking-before-publishing ) в том, что зачастую авторов хватает только на начальный этап — создание базы для презентации общественности, а дальше все, тишина. Но ведь автор/инициатор до определенного момента (а может и всегда) является единственной движущей силой подобных проектов. Без автора проект задохнется достаточно быстро.

Можно привести примеры из давних конкурентов ЛС — bigstreet, explay, cogear
  • ort
  • +1
  • ↓
Только зарегистрированные и авторизованные пользователи могут оставлять комментарии.