Sphinx Con JP 2015での発表 目的からドキュメントシステムを選べるYes/Noチャートは33ページにあります。 (当初アップロードしたものはこのページにミスがあったので差し替えています。高橋さんありがとうございます。)Read less
はじめに はじめまして、白川です。 システム開発では、多かれ少なかれドキュメントを作成する必要があると思います。 Word、Excelによって作成することが大体と思いますが、いろいろと問題点があるな、と感じるようになりました。 文書自体の整形(改行や改ページ、インデント、文字サイズ)が大変 仕様書が膨大になってくると、何がどこにあるかわからなくなり、内容のメンテナンス・維持が難しくなる 結果として、内容の陳腐化を招いてしまい、 ドキュメントと現実の仕様に差異が発生して、役に立たないドキュメントとなってしまいます。 そうなると、システムの仕様を把握するために、ソースコードをみないといけなくなりますし、 知見が担当者に依存してしまい、担当者が不在になると分からないことが多くなってしまいます。 それを防ぐために、 Python製のドキュメントビルダーであるSphinxを現在試しています。 Sph
Sphinx-Users.jp¶ Sphinx-Users.jp(略称#sphinxjp)は、美しいドキュメントを簡単に生成することができるドキュメンテーションツール、 Sphinx (スフィンクス)の普及を主眼としたコミュニティです。SphinxはPythonの公式ドキュメントだけでなく、このSphinx-Users.jpのサイトも含め多くのマニュアルやサイトで使用されており、詳細を Sphinxの歴史で紹介しています。 Sphinx-Users.jp は日本の Sphinx コミュニティです。 Sphinx-Users.jp では、日本で散らばっているSphinx関連情報を集めて、Webサイト、イベントを通じてSphinx情報を発信します。 slack のコミュニケーションや勉強会の開催などを通じて、ドキュメントをパワーアップしたい人、ドキュメントや翻訳で苦労している人、Sphinxの
業務での利用事例¶ 対象 ソフトウェア開発プロジェクト 規模:1名~10名前後 ドキュメント、書いていますか?¶ 想像してみてください。 この規模、たとえば1名のプロジェクトだとしたらどれくらいドキュメントを書くでしょうか?あるいは10名だったとしたら、どんな役割分担でドキュメントを書くでしょう。 そもそも、彼らはいつドキュメントを書くでしょうか。プロジェクトの方針がある場合、無い場合、色々なケースがあると思いますが、ドキュメントを作る事に対してかれらはどんなことを考えるでしょう。 ドキュメントを書いている割合¶ 業務のプロジェクトには大規模なものから小規模なものまでたくさんありますが、その数に対する「ドキュメントを書いている」比率は意外と低いのではないかと思います。前任者や別の部署・会社から引き継いだプロジェクトにまともなドキュメントがほとんどなかった経験がある方もいるのではないでしょう
Sphinx-Users.jp¶ Sphinx-Users.jp(略称#sphinxjp)は、美しいドキュメントを簡単に生成することができるドキュメンテーションツール、 Sphinx (スフィンクス)の普及を主眼としたコミュニティです。SphinxはPythonの公式ドキュメントだけでなく、このSphinx-Users.jpのサイトも含め多くのマニュアルやサイトで使用されており、詳細を Sphinxの歴史で紹介しています。 Sphinx-Users.jp は日本の Sphinx コミュニティです。 Sphinx-Users.jp では、日本で散らばっているSphinx関連情報を集めて、Webサイト、イベントを通じてSphinx情報を発信します。 slack のコミュニケーションや勉強会の開催などを通じて、ドキュメントをパワーアップしたい人、ドキュメントや翻訳で苦労している人、Sphinxの
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く