プログラミングスタイルガイドのスタイルガイド - Qiita
本文書は、プログラミング言語向けのスタイルガイドに向けたスタイルガイドである。 本文書へのフィードバックはQiita上のコメントにて受け付ける。 構造 対象を明確にする そのスタイルガイドがどのような状況のどのような対象に向けたスタイルガイドであるか規定すること。 状況や対象は広すぎてはならない。 理由: 対象はスタイルガイド記述者には自明かもしれないが、似て非なる言語に誤用されたり、特定分野のアプリケーション向けスタイルガイドが他分野のアプリケーションを理不尽に拘束したりすることがある。これを防ぐべきである。 良い例: 「本文書はRuby on Railsアプリケーション向けのスタイルガイドである」 「本スタイルガイドはX社におけるRubyプロジェクトに適用すべきスタイルを規定する」 悪い例: (何も書かない) 「本文書はX社におけるすべての開発に適用される ... 述語メソッドや述語関
RedPen
RedPen is a proofreading tool to help writers or programmers who write technical documents or manuals that need to adhere to a writing standard. RedPen automates the verifications of input documents written in natural languages — NOT computer languages such as C++ or Java. RedPen はプログラマや記者が規約にしたがって文書（マニュアルやソフトウェアドキュメント）を記述しているか検査します。 RedPen は自然言語で記述された入力文書のチェックを自動化します。 Customizable 柔軟な設定 RedPen is
ESDocというJavaScript向けのAPIドキュメントツールを作りました - maru source
こんにちは丸山@h13i32maruです。 昨日、ESDocというツールをリリースしました。GW中になんとかリリースできて一息ついているところです。今回はそのESDocというツールについて紹介します。あと最後に雑談と宣伝があります。 ESDocとは？ ESDocとはJavaScript(ES6)向けのAPIドキュメントツールです。JavaScript界隈ではJSDocがデファクトスタンダードであり、ESDocもJSDocに触発されて作りました。なのでタグの使い方はなるべく互換性を持たせています。とはいえ不要だなと思うタグもかなりあったのでそれらは実装していません。 ESDocの特徴(主にJSDocに比べて)としてはこんな感じです。 詳細なドキュメントを生成する ドキュメントカバレッジを計測する テストコードとドキュメントを関連付ける ES6のclass, import/exportを使った
GitHub - ktvoelker/standalone-haddock: Generate standalone haddock documentation for a set of packages
🚀 New maintainer wanted! It's not much work, but I don't use this software very often. I think a regular user would make a better maintainer. Please email karl@karlv.net if you are interested. standalone-haddock generates standalone haddock Haskell documentation. Note: you need this program to publish haddocks on your own website. If you want to upload haddocks to hackage instead, follow these in
Embulk: Docs
Built-in Plugins Configuration Embulk configuration file format Local file input plugin CSV parser plugin JSON parser plugin Gzip decoder plugin BZip2 decoder plugin File output plugin CSV formatter plugin Gzip encoder plugin BZip2 encoder plugin Rename filter plugin Remove columns filter plugin Local executor plugin Guess executor Preview executor Logo Images Logo Square Horizontal Icon Customiza
Announcing a Specification for Hack
Joel Marcey Announcing a Specification for Hack Posted February 19, 2015 Today we are excited to announce the availability of the initial specification for the Hack programming language. When we announced Hack, we were very excited for the community to get their hands on a programming language that has helped Facebook engineers become more productive in their day-to-day development and became, alo
esa.io と DocBase を比較してみた #esa_io #docbase - Tbpgr Blog
概要 esa.io と DocBase を比較してみました 利用歴 esa.io : 約 1 ヶ月 DocBase : 1日 ご覧のとおりのため、 DocBase については見逃している便利な使い方や私の勘違いなどあるかもしれません また、利用期間が大きく異なるため情報の量が esa.io に偏っていることをご了承ください。 esa.io の特徴について 下記の記事にまとめてあります。 ※ただし、記事作成後に使い易い機能が日々追加されています。 esa.io でゆるふわ情報共有 - Middleman Blog への Export サンプル付き DocBase の特徴について 下記の記事にまとめてあります。 「小さなメモから始めて、チームを育てる 」 DocBase を触って基本機能や特徴をまとめてみた 比較 コンセプトの違い esa.io 規模：小さなチーム向け 暗黙知可視化への工夫：W
研究方法
■心構え（研究室配属） 研究室リテラシー (島田 伸敬) 増井研でこの先生きのこるには（慶応大学増井研究室・@shokai）…大学の研究室の生活についての解説． 伊藤研究室への配属志望学生の皆さんへ (お茶の水女子大学 伊藤研究室) アカデミックマナーの心得 (東京大学大学院 情報学環・学際情報学府) 研究が進まないとき，どうするかー「研究が何であるか」まだわかっていない言語研究者の卵のための助言ー (黒田 航) ■心構え（大学院進学・留学） 博士課程の誤解と真実 ー進学に向けて、両親を説得した資料をもとにー (小野田 淳人) （2015年版）博士進学が決まったあなたが今すぐに始めるべきこと (発声練習)…ここで書かれていることは，アカデミックポストに応募するだけに限らず，一般的な院生の就職活動にも非常に重要です． 企業での博士・海外での博士 〜IT業界を例にして〜 (お茶の水女子大学 伊
DBコマンド横断比較リファレンスを作りました - clock-up-blog
横断的にDB操作の類似コマンドを探すためのサイト 例えば MySQL を知っている人が 新しく他のデータベース、例えば Oracle を学習する際に MySQL でいうところのアレは Oracle ではどういうコマンドなんだろう という感じに情報を探す場面が多くあります。 そういう類の情報を探すときに役に立ちそうなリファレンスサイトを作りました。 xref.jp xref.jp - Database 追記: コンテンツ増やしました yum, apt-get, rpm 等々の横断比較リファレンス - clock-up-blog ソースコード GitHub に上げてあるので興味ある人は見てみると良いです。 kobake/xref.jp · GitHub PHP で書いてます。すんごい汚いです。謙遜じゃなくて本当に。 プルリク歓迎。 機能 マトリクス方向の切替 比較表の見出しの向きって、その組み
第1回 自動文書検査ツールRedPenとは？ | gihyo.jp
はじめに 本連載ではRedPenという自動文書検査ツールの紹介とRedPenを利用した技術文書の校正方法について説明します。RedPenはオープンソースプロジェクトで、現在もゆっくりと開発が続いています。RedPenのホームページは次のとおりです。 http://redpen.cc RedPenは技術文書をターゲットにした文書の自動検査ツールです。技術文書にはマニュアルやチュートリアル、論文、仕様書等が含まれます。この記事のようなソフトウェアツールの紹介文書はもちろん技術文書の一つといえます。第1回の今回は、はじめに技術文書の特徴を解説し、その後RedPenを開発した動機について紹介します。記事の後半では、RedPenの特徴と利用方法について解説します。 技術文書の特徴 RedPenが対象とする技術文書ですが、作文や日記、文学作品等とは大きく異なる特徴をもちます。 最大の違いは、技術文書に
Main
pfff is a set of tools and APIs to perform some static analysis (e.g. to find bugs), dynamic analysis, source code indexing, code search, code visualizations, code navigations, or style-preserving source-to-source transformations such as refactorings on source code. There is good support for C, Java, PHP, JavaScript, HTML, CSS, and preliminary support for C++, Rust, C#, Erlang, Lisp, Scheme, Haske
REST APIのドキュメントに書かれているもの - Qiita
もし急にAPIドキュメントを書く必要が発生したら、何を参考にしたら良いのか。REST APIを提供しているサービスがどういった開発者向けドキュメントを提供しているのかについて調べた。今回対象としたサービスは、GitHub、Twitter、Square、DigitalOceanの4つのサービス。 https://developer.github.com/v3/ https://dev.twitter.com/docs https://developers.digitalocean.com/ https://connect.squareup.com/docs/api なお以下の文章の中では、個々のアクセス可能なメソッドとURLの組み合わせを指して「API」という言葉を使うことがある。例えば、GET /gists/:id という特定の投稿を取得するAPIや GET /gists/:gist_id
APIドキュメントを書くのが楽になるツールまとめ - Qiita
さいきんREST APIのドキュメントを書いていて、wiki使うのだるいし他に良い方法ないかな〜と調べてた時に見つけたツール群をまとめてみます。 追記: こちらも便利そうなので参考にどうぞ。 REST APIドキュメント作成ツールはapiary.ioが決定版かもしれない - Qiita swagger Swagger: A simple, open standard for describing REST APIs with JSON | Reverb for Developers デモ: Swagger UI ソースコード中にAPIの概要を書いておくと、それを元にドキュメントを自動生成してくれる。wikiやmarkdownで書くのと決定的な違いは、↓のようにドキュメント上のformからAPIコールを試すことができる点。 様々な言語のWAFに対応したライブラリも開発されてる。 Home ·
iodocsで便利なREST APIドキュメントを作成する - Qiita
wikiとかでドキュメントを書くのが面倒で、良いツールを探していたらiodocsというnode製ツールを見つけた。 これを使うとドキュメント作成が楽になるだけじゃなく、 ドキュメント上のformからAPIリクエストを試せて便利っぽい。 普段APIドキュメントを見つつcurlとかでリクエスト送信して試してたのが、全てドキュメント上で完結して良さげ。 使い方 mashery/iodocsからcloneしてアプリを起動すると、FoursquareやLinkedin APIを叩くサンプルをすぐに試せる。redisが必要なのでserver起動を忘れずに。 ~/ $ git clone http://github.com/mashery/iodocs.git ~/iodocs $ npm install ~/iodocs $ redis-server & ~/iodocs $ npm start {
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Ronn
Quickdocs
Kaizen Platform における UI ライブラリのワークフロー
Enunciate
Best Practice
情報共有ツール DocBase(ドックベース ) | ストレスフリーなドキュメント共有ツール
