タグ

Documentationとjenkinsに関するni66lingのブックマーク (1)

  • Sphinx + Jenkins で始めるドキュメントの継続的インテグレーション | TECHSCORE BLOG | TECHSCORE BLOG

    はじめに はじめまして、白川です。 システム開発では、多かれ少なかれドキュメントを作成する必要があると思います。 Word、Excelによって作成することが大体と思いますが、いろいろと問題点があるな、と感じるようになりました。 文書自体の整形(改行や改ページ、インデント、文字サイズ)が大変 仕様書が膨大になってくると、何がどこにあるかわからなくなり、内容のメンテナンス・維持が難しくなる 結果として、内容の陳腐化を招いてしまい、 ドキュメントと現実の仕様に差異が発生して、役に立たないドキュメントとなってしまいます。 そうなると、システムの仕様を把握するために、ソースコードをみないといけなくなりますし、 知見が担当者に依存してしまい、担当者が不在になると分からないことが多くなってしまいます。 それを防ぐために、 Python製のドキュメントビルダーであるSphinxを現在試しています。 Sph

  • 1