オンラインドキュメントと日本語全文検索
自社では Sphinx というドキュメントツールを利用しているのですが、残念ながらこれに付属している検索機能の日本語検索はかなり厳しいです。また残念ながら Sphinx 開発側も検索周りを改善するという予定は直近ではないようです。 そして検索というのはとても難しい技術なため自分のような素人では導入して「普通に期待する動作」をさせるまでの距離はとても遠いです。 ただ、なんとかして日本語全文検索を実現したいという思いはここ10 年くらいずっと思っていました。これは自社の Sphinx テーマを作ってくれている社員ともよく話をしていたのですが、どうしてもリソースをつぎ込めずにいました。 まとめ日本語検索に対応している Meilisearch を採用したドキュメントスクレイパーの実行は GItHub Actions (Self-hosted Runner) を採用した自社 Sphinx テーマの検
gitbookで設計書を作成したら最高だった話 - フォトシンス エンジニアブログ
こんにちは。Akerunエンジニアの @ishturk です。 Akerun Advent Calendarの記事です。 今日は設計書の話です。 設計書をどんなツールで書くかは、僕らソフトウェアエンジニアの尽きない悩み（楽しみ）ですね。 最近はまったツールが最高に良かったので紹介させてください。 僕のツールに求める要件は以下です。 編集がカジュアルにできる UMLが書ける。あとから編集できる（画像での貼付けは編集できないのでNG） バージョンの管理ができる 好きになれる（重要） 変遷と pros/cons MS Word pros 良くも悪くもスタンダードなツールですね。 だれでも編集できるのが強みです。 Visioと組み合わせれば、UMLも後から編集可能です cons Visioは標準にするには少々値が張ります。 バイナリ形式なのでバージョン管理はしづらいです。 ページが増えたり画像を貼
ドキュメントの継続的な開発方法 | IIJ Engineers Blog
私はソフトウェア開発を主体とするエンジニアで、 クラウドサービスの開発・運用 分散処理技術の検証とサービス利用の検討 社内の開発支援環境の開発・運用 などの業務に従事していますが、今回の記事は業務とは直接的な関係は無く、私が会社で勝手自発的に行っている取り組みについて書きたいと思います。 昨今、インターネットは生活に深く浸透し、クラウドサービスを利用することで安く簡単にWebサービスを開発、公開できるようになりました。Web技術の進化や流行の移り変りも非常に激しく、既存サービスの機能追加や新規サービスの開発は頻繁に行われています。それは弊社も例外ではありません。 このような開発の現場では、リーンソフトウェア開発への取り組みなど開発手法の最適化が積極的に行われ、様々なベストプラクティスが生みだされています。それらのベストプラクティスには、 継続的インテグレーション や 継続的デプロイメント
大正義plantUMLがエンジニアをUML地獄から救う - Bye Bye Moore
plantUMLはテキストであの忌々しいUMLを書き表す拡張です。 利用環境一覧 PlantUML 導入法 Sphinx http://plantuml.sourceforge.net/download.html emacs Emacs から PlantUML を使ってみた - あらびき日記 ブラウザ上での簡易確認 単に動作を確認したいだけであれば、 PlantUMLServer で動作をみることもできます。 sequence diagram Father <- MYN : すいません許してください!何でもしますから! Father -> MYN : ん？ 今なんでもするって、言ったよね？ use case diagram @startuml left to right direction skinparam packageStyle rect actor customer actor c
Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO
渡辺です。 開発者の間ではgithub式Markdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは？ Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS
pythonでオフィス快適化計画
日本マイクロソフト株式会社 Digital Sales 事業本部 Digital Cloud Solution Architect 上坂 貴志 クロスプラットフォームに対応した .NET Core、.NET 5 を得てリリースされた .NET 6は待望の LTS (Long-term Support)です。新規開発であれば .NET 6 での開発を検討できますが、.NET Framework で作成された既存のシステムはどうすれば良いでしょうか。 .NET Framework は version 4.8 を最後に新機能の追加予定は今のところありません。今後のことを考えて .NET 6 へのアップグレードを検討したいところですね。 このセッションでは .NET Framework から .NET 6 へのアップグレードについての様々な情報をお伝えします。
ドキュメント作成ツールの検討(Sphinx、ReVIEWとか) - wadahiroの日記
今後、マニュアルを書いてメンテナンスも継続的にしていく機会が丁度ありそうなので、現時点(2012/05/02)でどのツールが自分たちにフィットするか検討してみた。ツールの候補は以下。なお、過去の仕事ではWordとDocBookは経験あり。 Word DocBook Sphinx ReVIEW 前提 今回のマニュアル作成の前提は以下の通り。 複数人で作業し、1つのドキュメントを作成する(主に章単位でアサイン)。 特定顧客向けに部分的にカスタマイズして提供することもある。 外部向けのドキュメントなので、体裁はそれなりに整っている必要がある。 製品のエディションによってマニュアル構成が変わる(上位のエディションだと機能が増えるので章や節、説明が増えるなど)。 出力フォーマットはWordまたはHTMLならOK。PDFは必須ではない。 ドキュメント中に画像はそれなりにある。スクリーンキャプチャ、構成
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
システム開発や保守、運用の現場においてドキュメントは必須のものです。 しかし、ドキュメントの作成・維持には多くのパワーがかかるため、ドキュ メントが存在しない、資料が古いままになっているなどといった現状を多く 耳にします。 本勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、 みるみるうちに図を作成できる「blockdiag」をご紹介します。 「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの 画像ファイルを出力可能なオープンソースの画像生成ツールです。書き やすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに 配置や並べ替えに苦労する必要はありません。 blockdiagのサンプルはこちら このような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成 するツール「Sphinx」を組み合わせることによって
Sphinx (PDF 出力) を導入してみた - Twisted Mind
注意 PDF 出力を前提とした話しになっています OSS のドキュメントとしてはよく使われておりますが、実際に仕事の道具として導入してみた人はあまりいないのではないでしょうか。 導入のきっかけや、実際導入した際の環境などを書いて行ければと思います。 注意事項としては Sphinx を自分自身はまったく使いこなしていないので、Sphinx やそれらの「技術的」な話しは出来ません。そこを期待されている方は @aohta に「話しを聞きたい」とかリプライ飛ばすともしかすると書いてくれるかも知れません。 ドキュメントツール導入のきっかけ もともと Word が使いづらく reST を自分個人で使い続けてました。使い始めたきっかけは @everes が使っていたからだったと記憶しております。一人でほそぼそと使っていましたが、rst2pdf がきっかけになって社内で使ってみたらどうか？という話が出てき
書籍執筆における、継続的なデリバリー - Natural Software
今回の本は3人で書いたこともあり、前回と比べて執筆環境を大きく変えました。 その中の一つに「最新の原稿を、すぐに電子書籍の形で確認できる」環境があります。 専門的に書くと 「Sphinxのドキュメントを、githubにpushすると、JenkinsがビルドしてePubにしてくれる」 ようにしました。もう少し砕くと 「原稿を、インターネット上で共有している場所に置くと、自動で電子書籍の形にしてくれる」 でしょうか。 具体的には、左のようなテキストが、右のような電子書籍に(自動で)なります。 自動的に生成された電子書籍を確認することで、編集者や著者が最新の原稿の内容を確認できるようになっています。 オーム社やオライリー社でやってる制作システムを自前で構築しました、ということです。 より詳細な構築方法については、反響を見て考えようかと思います(アカウント管理やなんかがちょっと手間になりそうなので
SphinxかわいいよSphinx - marsのメモ
ビルド職人本も出てノンビリしてたんだけど、脳みその中が揮発する前に、ちょっと書いてた間のことも残しておこうと思ってみたり。 原稿なんですが、[twitter:@dentomo]さんからは「テキストファイルかWordでお願い」って言われました。へー、Wordアリなんだー、ってのとテキストって正真正銘プレーンテキストなのね、とそのギャップが面白いなと思った。で、結局どうしたかっていうと Sphinxで書いた。 うん、全然、人の話聞いてない。:-) 言い訳言うと、Word持ってない＆プレーンテキストで脚注やら連番やら書くのは骨が折れるなって思ったから。後、Sphinxでテキストに変換すりゃいいだろうって思ったから。で、結論から言うと、Sphinxイイヨ。。reSTのマークアップも意外と表現力あって、あまり不満に思うこと無かった。なにより、脚注とかのクロスリファレンス、レイアウトのプレビューができ
Sphinx 社内勉強会 - forest book
Sphinx について何か話せというお題をもらって紹介してきました。 私自身、Sphinx をちょっと使った程度のレベルなのであんまり突っ込んだ内容ではありません。大体こんな感じの全体像で、こんな拡張ツールがあるよといった紹介をしました。プレゼン資料では分かりませんが、実際にデモで Sphinx のプロジェクトを作って、reST を書きながらビルドするとか、tex ファイルを作ってから pdf をビルドするとか、 $ python setup.py build_sphinx で簡単にパッケージングと連携することもできるとか、私が使ってきた中で知ってることを紹介しました。 興味をもってくれる人がいたら嬉しいなぁ。 Sphinx 社内勉強会 おまけで ikazuchi のデモもしてみた (^ ^;;
Shibu's Diary: 検索エンジン改造して遊ぼう！
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 by efilpera under CC BY-NC-SA tk0miyaさんから、Python Web フレームワークアドベントカレンダーのパスが回ってきました。ちなみに当方、現在、The Art of Communityの翻訳直しが佳境なのと、本田技術研究所を辞めて転職することにしたのと、それに伴って引っ越しの準備やらで首がまったく回っていません。Pythonのアドベントカレンダーは、なぜか遅れるとバリカンという殺伐した話になっていて、恐怖で禿げそうです。あ、退職の話は年末に落ち着いたら書くかも。 今回のネタは、僕がユーザグループの会長をやっている、Sphinxのお話にしようと思います。Sphinxに関しては、@r_rudiさんが実用系の話を既に書いてくださっていますので、
BBIQ光の口コミや評判｜料金や速度など九州エリア限定のビビックを解説 – ネットログ
この記事では、BBIQ光の基本情報や通信速度の実測値、実際にBBIQを利用している方の評判などを詳しく解説していきます。 「BBIQ光の通信速度は速いの？」「料金はいくら？」「実際の利用者の評判は？」など気になる方は多いですよね。 BBIQ光は九州電力のグループ会社である「株式会社QTnet」が提供している九州地方限定で利用できる光回線サービスです。現在利用している方の口コミでは、通信速度が速くて快適・割引サービスが豊富との嬉しい声が多く挙がっていますよ。 BBIQ光の申し込み窓口は少ないものの、公式の他に代理店からも申し込みが可能です。特におすすめの申し込み窓口が『NEXT』です。最短1ヶ月で最大30,000円のキャッシュバックが受け取れるので、よりお得にBBIQ光に契約したい方はぜひNEXTからの申し込みを検討してみてくださいね。 その他にもお得なキャンペーン情報も詳しく解説します。B
渋日記: 1日〜1週間のでOSSに貢献する方法
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 OSC 2009 Tokyo/FallのLTで発表してきました。ACアダプタを忘れて、Windows PCで発表する予定だったのを、バッテリー持ちの良いMacBookにスイッチ。また、当日はPloneのブースで山本烈さんにアダプタをお借りしました。「電源とRGBケーブルありますよ！」とmixiを見てダイレクトメッセージを送ってくれた清水川さんともども、感謝申し上げます。 なぜかトリだったのですが、トラブルがあってその前に。タイマーが無かったのでiPod Touchの時計を表示しながら話していましたが、省電力設定がONのままだったので、ちょくちょくロックがかかってしまったのは失敗でした。今度から気をつけよう。 今回は話す内容がほぼそのままスライドになっているので補足するところは少
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Markdownでドキュメンテーションを書かないで下さい
GitLab 10.1 に GitLab CI + GitLab Pages + Sphinx でドキュメントビルド環境を整える
Sphinxの全文検索を複合語に強くする
Excel 方眼紙撲滅委員会 活動報告 2012.11 #odstudy
redirecter