残業も減らせる!? 上級エンジニアになるためのDesign Doc超入門
残業も減らせる!? 上級エンジニアになるためのDesign Doc超入門：プロジェクト成功確率向上の近道とは？（3）（1/3 ページ） ITシステム開発の問題点の一つであるコミュニケーションの失敗。本連載では、これを防ぐ方法としてお勧めしたい3つのドキュメントを紹介していく。今回は、「技術視点」のドキュメントとして、2000年代以降注目されている「Design Doc」について解説します。 IT技術がビジネスに貢献していくためには、まずはシステム開発を成功させることが重要です。本連載「プロジェクト成功確率向上の近道とは？」では、システム開発を成功させるために、コミュニケーションが果たす役割の重要性と、ドキュメントによるコミュニケーションの重要性について解説してきました。 連載1回の「ドキュメントは最強のコミュニケーションツールである――Joelの機能仕様書入門」、第2回の「サンプル例に見る
YARD - A Ruby Documentation Tool
What Is YARD? YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Above is a highlight of the some of YARD's notable features. And of course YARD comes with muc
ReadTheDocsでSphinxホスティングは磐石（になる予定） - YAMAGUCHI::weblog
はじめに こんにちは、Sphinx-Users.jpの賑やかし担当です。最近PHP界隈でも人気の高いドキュメント生成ツールSphinxですが、みなさん楽しいSphinxライフを送っていますでしょうか。さて、Sphinxでドキュメントを作った場合、一番キャッチーなのはHTMLだと思うんですが、そのホスティングはみなさんどうされていますか？ Sphinx-Users.jpにいくつかホスティングの方法を紹介してありますが、今日は割と新しいホスティング方法のReadTheDocsをご紹介します。 ReadTheDocsってなに？ Home | Read the Docs rtfd/readthedocs.org · GitHub ReadTheDocsは2010年のDjango Dashで作成されたコードを元に公開されているサービス/ライブラリです。外部に公開されているSphinxのレポジトリ（G
Full featured documentation deployment platform
Documentation simplified Build, host, and share documentation, all with a single platform. Sign up now Easy previews and deploys Preview changes on every commit to your pull requests. Release documentation to your users on each merge. Ideal developer experience Write documentation without changing your workflow or your tools using a docs as code approach. Work privately or publicly Easily share wi
Python コメント、Pydoc - @//メモ
コメントの書き方 † 例 : function1.py #!/usr/bin/env python # coding: utf-8 """ 関数の練習 """ __author__ = "kagyuu <kagyuu@hondou.homedns.org>" __version__ = "0.00" __date__ = "14 Oct 2012" ####################################################################### def func1(arg1, arg2, arg3='3rd') : """ 一般的な関数. @param arg1 引数1 @param arg2 引数2 @param arg3 引数3 (デフォルト値 '3rd') @return 引数の辞書(key = ('arg1', 'arg2', 'arg
Doxygen
設定 フォーマット 設定ファイルは、Makefile に似た構造を持つ、自由形式の ASCII テキストファイルで、デフォルトでは Doxyfile という名前になります。 ファイルは、doxygen によって解析されます。 書式設定のため、タブや改行コードを入れられます。 ステートメントは、大文字と小文字が区別されます。 ファイル内のどこにでもコメントを置くことができます (クォートの中を除く)。 コメントは、# 文字で始まり、行の終わりまで続きます。 ファイルは、本質的には、代入文のリストからなっています。 各ステートメントは、大文字で書かれた TAG_NAME の後に = 文字と1つ以上の値が続いたものです。 同じタグへの代入が 2回以上現れた場合は、最後の代入文だけが有効になります。 引数にリストを指定するオプションについては、= のかわりに += 演算子を使って、リストに新しい値
Python pydocの使い方、書き方とhtml出力の方法 - Symfoware
JavaのJavaDocと同様、Pythonにもpydocがあることは知っていたのですが、 使ったことがなかったので、ちょっと調べてみました。 helpでの表示 pythonのインタープリターを起動して、help()を実行すると、モジュールに 記載されたドキュメントが表示できるようになります。 試しに、httplibと入力してみると、こんな感じでモジュールのドキュメントが表示されました。 なんだかかっこいいです。 「q」と入力すると、helpモードを抜けて、インタープリターに戻ります。 書いてみる 記載した内容がどの部分に表示されるのか知りたかったので、 適当にサンプルを書いてみました。 # -*- coding:utf-8 -*-"""ファイルの先頭に書いたコメント"""__author__ = "作者 <mail@example.com>"__status__ = "productio
NAMAKESUGI | YARDがすごい
FlexやRuby on Railsなどで使い方とかを自分が後でわかるようにメモしておくブログ。最近はFlex系に飽きてます。 [ruby]rdocは捨て去られてYARDになった[gem] 皆さんはrubyやrailsのドキュメントをどのように作成されていますか？ rdocだとjavadocみたいなことができないーーーということに悩んでいませんか？ そんなときにはこれをお試しください。 yardとは rdocの進化版 すごく綺麗なリファレンスが作成できます 参考URLとしてyardの凄さを表したのがこのページです。 => Gemリファレンス Gemに登録されているライブラリをyardで表示しています。 インストール 今回利用したのは0.6.4です。なおrdocの生成を勝手にしますが、失敗します。 gem install yard ドキュメント生成方法 RAILS等のルートディレクトリで実行
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
https://sphinx-users.jp/doc10/tutorial.html
Python Docstrings