Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
lyzhenko opened this issue Sep 6, 2021 · 4 comments
Labels
documentation Improvements or additions to documentation EDT plugin wanted Нужен такой плагин для 1C:EDT

Comments

@lyzhenko
Copy link

lyzhenko commented Sep 6, 2021

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

@marmyshev
Copy link
Owner

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

@marmyshev
Copy link
Owner

marmyshev commented Sep 6, 2021

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

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

@marmyshev marmyshev added EDT plugin wanted Нужен такой плагин для 1C:EDT documentation Improvements or additions to documentation labels Sep 6, 2021
@lyzhenko
Copy link
Author

lyzhenko commented Sep 6, 2021

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

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

@lyzhenko
Copy link
Author

lyzhenko commented Sep 6, 2021

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation EDT plugin wanted Нужен такой плагин для 1C:EDT
Projects
None yet
Development

No branches or pull requests

2 participants