search

marmyshev / edt-plugins

Общрий репозиторий-агреггатор всех плагинов для 1C:EDT. Идеи для разработки новых плагинов для 1C:EDT, платформы 1С:Предериятия и продуктов 1С, интересные плагины Eclipse которые можно/нужно использовать в 1C:EDT.
https://marmyshev.github.io/edt-plugins/
MIT License
164 stars 16 forks source link

Добавление пользовательской документации #31

Open lyzhenko opened 3 years ago

lyzhenko commented 3 years ago

Идея состоит в том что помимо официальной документации добавить в справку пользовательскую документацию, то есть создать репозиторий на github и хранить документацию в Markdown, сообщество ее дополняла и изменяла.

marmyshev commented 3 years ago

Уточни, документацию на что?

marmyshev commented 3 years ago

вообще, собирать такую доку и поставлять в виде плагина (который будет в справке, с индексированием и поиском) - нет проблем! легко и быстро сделать такой плагин!

Мне кажется, что основная трудность будет в том, чтобы собрать материал и сообщество чтобы контрибутило (имхо конечно)

lyzhenko commented 3 years ago

Уточни, документацию на что?

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

lyzhenko commented 3 years ago

Мне кажется, что основная трудность будет в том, чтобы собрать материал и сообщество чтобы контрибутило (имхо конечно)

Да вы правы что все будет завесить от сообщества.