ドキュメント資料集

ここでは、技術ドキュメントの書き方、ドキュメントの活用法などについて紹介します。

プロジェクトのドキュメント作成

../_images/expertpython_mini.jpg

本ドキュメントは、アスキー・メディアワークスから2010年5月31日発売のエキスパートPythonプログラミングの10章のサンプルです。原著でも10章がサンプルとして公開されていますが、翻訳書でも10章を公開できる運びとなりました。

テクニカルドキュメントの書き方から、ドキュメントの種類など、ソフトウェア開発におけるドキュメンテーションについて、幅広く説明されています。最後にSphinxについても説明されています。

注釈

Sphinx-Users.jpに関わっている、清水川、渋川が翻訳に参加しました。

Python Enhancement Proposal: 1

PEPというのはPythonの機能拡張、要望、リリース計画などを記述するのに使用される公式なドキュメントの記述方法です。オープンソースの中でも屈指のドキュメントの充実ぶりを見せるPythonのコアとなる部分で、「開発コミュニティを動かすドキュメント」です。PEP 1は、その中でも、PEPのワークフローを定めたメタなPEPです。

最近ではErlangもPythonに習って、EEPとして取り入れています。

翻訳者:渋川よしき(2010/05/01)
原文:http://www.python.org/dev/peps/pep-0001/

Python Enhancement Proposal: 3120

このPEPはデフォルトソースエンコーディングをASCIIからUTF-8へ変更することを提案します。代替となるソースエンコーディング、つまり明示的なエンコーディング定義をデフォルトよりも優先することは継続的にサポートします。

翻訳者:森本哲也(2010/07/25)
原文:http://www.python.org/dev/peps/pep-3120/