Введение¶Introduction

Документация Python уже давно считается качественной для свободного языка программирования. Этому есть несколько причин, важнейшая из которых – ранняя приверженность создателя Python, Гвидо ван Россума, к предоставлению документации по языку и его библиотекам, а также постоянное участие сообщества пользователей в помощи по созданию и поддержке документации.

Участие сообщества принимает множество форм: от написания документации до сообщений об ошибках и просто жалоб, когда документация могла бы быть более полной или удобной в использовании.

Этот документ предназначен для авторов и потенциальных авторов документации Python. Более конкретно, он предназначен для людей, вносящих вклад в стандартную документацию и разрабатывающих дополнительные документы с использованием тех же инструментов, что и стандартные документы. Это руководство будет менее полезно для авторов, использующих инструменты документирования Python для тем, отличных от Python, и ещё менее полезно для авторов, не использующих эти инструменты вообще.

Если вас интересует вклад в документацию Python, но у вас нет времени или желания изучать reStructuredText и структуры разметки, описанные здесь, для вас также найдётся место среди участников Python. В любое время, когда вы почувствуете, что можете прояснить существующую документацию или предоставить недостающую документацию, существующая команда документации с радостью поможет вам интегрировать ваш текст, взяв на себя работу с разметкой. Пожалуйста, не позволяйте материалу этого документа стать преградой между документацией и вашим желанием помочь!