The Internet belongs to everyone. Let’s keep it that way.

Protect Net Neutrality
Loading presentation...

Present Remotely

Send the link below via email or IM

Copy

Present to your audience

Start remote presentation

  • Invited audience members will follow you as you navigate and present
  • People invited to a presentation do not need a Prezi account
  • This link expires 10 minutes after you close the presentation
  • A maximum of 30 users can follow your presentation
  • Learn more about this feature in our knowledge base article

Do you really want to delete this prezi?

Neither you, nor the coeditors you shared it with will be able to recover it again.

DeleteCancel

多忙なSEのためのドキュメンテーションツール Sphinx

No description
by

Kenji Kumabuchi

on 2 September 2014

Comments (0)

Please log in to add your comment.

Report abuse

Transcript of 多忙なSEのためのドキュメンテーションツール Sphinx

ドキュメントとは?
1 資料的な文書。記録。
2 記録映画。記録文学。
3 コンピューターでプログラム開発の際に作る仕様書や使用説明書。
(goo辞書より)

システムを開発していく上で、ドキュメントは何度も更新される。
機能追加、画面変更、バグ修正 ...etc
↓        
画面帳票.xlsx、画面帳票_修正版.xlsx、画面帳票_20140905.xlsx

ドキュメントってめんどくさい
reStructuredText (ReST)
Fri, September 5, 2014
品技本 技術SE部 ITA部門 システム性能担当 熊渕 健二
美しいドキュメントを簡単に
Sphinxってなに?
見た目を彩る豊富なテーマ
多忙なSEのための
ドキュメンテーションツール Sphinx

ReSTと呼ばれるテキスト形式のファイルからHTMLやPDF等さまざまな形式のファイルを
エクスポートするドキュメンテーションツール。

豊富な日本語ドキュメント。
 → http://sphinx-users.jp/
インストールはとっても簡単。
 $ sudo apt-get install python-sphinx
書き始めるのもとっても簡単。
 $ sphinx-quickstart
エクスポートもとっても簡単。
 $ make html

豊富なテーマで見た目もキレイ。
機能拡張で機能をどんどん追加できる。
自己紹介
・2014年入社
・負荷発生ツールJMeterの
ドキュメント作製&PJ支援
・兵庫県出身(姫路から北へ1時間のところ)
・毎週日曜、原木中山でバスケやってます!
・学生時代に機械学習(映像検索)の研究

熊渕 健二
Kumabuchi Kenji
・差分、バージョン管理
・階層化
・フォーマット変換
・見やすさ      etc
体裁や形式ではなく、
書く内容に集中したい!
まとめ
Sphinxでできること
・テキスト形式で書けるため
差分、バージョン管理が容易

・reS
tructuredText

シンプルに階層化

・HTML、PDF、ePubなど
様々なフォーマットで出力
可能!
・豊富なテーマで
見た目もキレイ
に!

HTMLに出力って、デザイン部分も作らないといけないの?
 No! 豊富なテーマの中から自分の好きなテーマを選べる!
見出し
=や-でデコレーション
例)
======
大見出し
======

中見出し
======

小見出し
---------
リスト
先頭に - や #
例)
- list 1
- list 2
- list 3

# list 1
# list 2

1. list 1
2. list 2
..image:: path/img.png
画像の挿入
外部リンク
`アンカー<URL>`_
内部リンク
内部リンク定義
 .. _linkindex1:
内部リンク参照
 :ref:`linkindex1`
ReSTファイル
Sphinx
大見出し
中見出し
小見出し
・list 1
・list 2
・list 3
1. list 1
2. list 2
1. list 1
2. list 2
Full transcript