前のトピックへ

Python のドキュメントの作成

次のトピックへ

2. スタイルガイド

このページ

1. 初めに

Python のドキュメントは長い間、フリーなプログラミング言語としては良いものであると考えられてきました。その理由は多々ありますが、最も重要なのは、 Python の作者である Guido van Rossum が、言語やそのライブラリのドキュメントの提供と、ドキュメントの作成と維持の手助けする上でのユーザコミュニティの継続的な参加に早期から関わっていたことです。

コミュニティの参加には、バグ報告の作成から、単にドキュメントをより完全で利用しやすいものにできる場合に素朴な提案をするといったことまで、いくつものやりかたがあります。

このドキュメントは、Python のドキュメントの作者、あるいは潜在的な作者向けのものです。もっと具体的にいうと、標準ドキュメントに貢献したり、標準ドキュメントと同じツールを使って別のドキュメントを開発する人々向けです。このガイドは Python 以外のトピックに Python ドキュメント作成ツールを使う作者にとってはあまり有用ではなく、ツールを全く使用しない作者にもあまり有用ではないでしょう。

仮に、あなたが Python のドキュメントを寄贈したいと思っている一方で、 reStructuredText を学んだり、このドキュメントに書かれているマークアップ構造を学んだりする時間や気力を持てないとしても、あなたを Python プロジェクトへの協力者として迎え入れる余地はあります。既存のドキュメントを改善したり、欠けているドキュメントを提供してもらえるなら、現在のドキュメント製作チームがいつでも喜んでマークアップを行い、テキストを組み込みます。手助けしたいという気持ちをお持ちなら、このドキュメントに書かれていることを障害のように思わないでくださいね!