Стандарти Документації
Цей документ надає вказівки з документування коду, проектів та процесів ефективно. Чітка та всебічна документація є важливою для розуміння та майбутнього обслуговування наших проектів.
1. Документація Коду
У code-conventions.md ми встановили конвенції коду. Крім того, документація коду повинна відповідати наступним стандартам:
Коментарі: Використовуйте коментарі обережно та старайтеся досягати самовідповідності коду. Додавайте коментарі лише для складних алгоритмів або для пояснення невідомих розділів коду.
Встроєна Документація: Використовуйте інструменти встроєної документації, якщо це застосовно (наприклад, JSDoc для JavaScript).
2. Документація Проекту
Правильна документація проекту є важливою для введення та обслуговування проектів. Дотримуйтесь цих стандартів:
README.md: Кожен проект ПОВИНЕН мати всеосяжний README.md, який охоплює загальний вигляд проекту, інструкції з встановлення, приклади використання та вказівки щодо внесення.
Wiki: Розгляньте можливість використання вікі репозитарію для глибокої документації, посібників та навчань.
Діаграми Архітектури: У разі потреби додайте діаграми високого рівня архітектури для полегшення розуміння.
Внесення в Стандарти Документації
Якщо у вас є пропозиції або покращення для цих стандартів документації, будь ласка, відкривайте питання або надсилайте запити на витяг. Ваш внесок допомагає забезпечити чітку та ефективну документацію у всіх наших проектах.