.. ======= Summary ======= ========= まとめ ========= .. This chapter explained in detail how to: * Use a few rules for efficient writing * Use reStructuredText, the Pythonistas LaTeX * Build a document portfolio and landscape * Use Sphinx to generate nice web documentation 本章では次のようなことを、どのように行うのかについて、具体的に説明してきました: * 効果的に文章を書くための、いくつかのルールの使用方法 * PythonistaのLaTeXとも言うべき、reStructuredTextの使用方法 * ドキュメントのポートフォリオとランドスケープの構築 * すばらしいWebのドキュメントを生成することができる、Sphinxの使用方法 .. The hardest thing to do when documenting a project is to keep it accurate and up to date. Making the documentation part of the code repository makes it a lot easier. プロジェクトのドキュメントを作成する上で一番難しいことは、ドキュメントを正確かつ最新に保つことです。コードリポジトリの中にドキュメント保存用の領域を作ることで、それがずっと簡単になります。 .. From there, every time a developer changes a module, he or she should change the corresponding documentation as well. そのような置き場を設置したら、開発者がモジュールに変更を加える時にはいつも、関連するドキュメントにも変更を加えるべきです。 .. This can be quite difficult in big projects, and adding a list of related documents in the header of the modules can help in that case. この作業は大型のプロジェクトでは極めて困難になることもあるでしょう。その場合、モジュールのヘッダーに関連するドキュメントのリストを追加すると簡単になります。 .. A complementary approach to make sure the documentation is always accurate is to combine the documentation with tests through doctests. ドキュメントが常に正しいということを保証するための補助的なやり方としては、doctestを通じて、ドキュメントとテストを一体化してしまう方法があります。 .. This is covered in the next chapter, which presents Test-Driven Development principles, and then Document-Driven Development. これらに関しては、テスト駆動開発やドキュメント駆動開発の原則について説明を行う、次章で触れていきます。