ESDocという(多分)モダンなドキュメンテーションツールの紹介 - maru source
こんにちは丸山@h13i32maruです。 僕は2015年からESDoc*1というJavaScript向けのドキュメンテーションツールを開発しています。 https://esdoc.org https://github.com/esdoc/esdoc Star 最初のリリースから2年、昨日ようやくv1.0をリリースできました🎉 いやー、ここまで長かったです。今ではRxJSやSketchAPIなど、様々なツールで使用されています。 この2年間、ESDocは2つのゴールを目指して開発してきました。 ドキュメントの作成・メンテナンスを快適にする（ドキュメントを書くの楽しい！という状態） ソフトウェアの使い方を簡単に理解できるドキュメントを作成する（ソースコード読まなくても大丈夫！という状態） この2つを満たすためにESDocは色々な機能を提供しています。 今日はそれらの機能の中でも(多分)モダ
開発のドキュメントをどこに置くか問題 - $shibayu36->blog;
最近開発用のドキュメントをどこに配置するか悩んでて、いくつか試して見てる。今回言っている開発用のドキュメントというのは、コードの触り方も含んだサービスの開発に関するもの。例えば 開発環境セットアップ方法 ページに表示している広告をどのように切り替えたりするか(googleの管理やコードの変更も含めた) サービス内の特定の機能の仕組み 内部用HTTP APIドキュメント などを指している。 結構いろいろ考えるところがあるので、思っていることをまとめてみたい。一応先に結論を言っておくと 基本は実装に一番近いところにコメントとしてドキュメント書くのが良いと思う いろんなパーツが絡みあうような大きな機能の場合、導入部分だけ別の場所に書く 出来るだけrepository内に入れておくと探しやすく、更新しやすいと思う あといろいろ悩んでるので事例あったら教えてください。 起きている問題 ドキュメントは
TypeScriptのAPIドキュメントをyuidocjsで自動生成 - 成らぬは人の為さぬなりけり
現在、仕事でTypeScriptを使っていますが、 APIドキュメントが欲しくなってきて、 JavaDocとか、RDocとか、ScalaDocとか、みたいに 自動生成させたいなぁと思い、いろいろ試してみました。 試したツール jsdoc (npm) JsDoc Toolkit jsduck (gem) yuidocjs (npm) 試した結果 jsdoc : module以下のクラスのdocが生成できなかった JsDoc Toolkit : jsdocと同じ jsduck : docに定義されているタグが足りないとエラーになる yuidocjs : module以下のクラスもdoc生成できた と、いう訳で、yuidocjsを使ってドキュメント生成することにしました。 以下、環境構築手順と使い方についてメモしたいと思います。 環境 MacOSX 10.8.3 npm 1.2.14 types
文書ごとに最適な「構成のフレームワーク」は異なる
「提案書」や「要件定義書」は書くのが難しい。読む人がITの専門家ではないからだ。専門用語を使わず、高度な内容を的確に伝えるにはどうすればいいか。「提案書」「要件定義書」の書き方を通じて、「誰にでも伝わる」文章術を伝授する。 第3回「分かりやすい提案書はアウトラインが美しい」、第4回「『要件定義書のアウトライン作成』完全マニュアル」で説明したように、全体を「階層構造」にすると文章が読みやすくなります。特に、提案書や要件定義書、マニュアルのようにページ数が多い文書は、必ず階層構造にしましょう。さて、今回は「階層構造を作った次のステップ」を説明します。 いきなり文章を書き始めるのはNG 階層構造を作ったら、いよいよ中身の文章を記述します。このとき、思いつくままに文章を記述し始めてはいけません。分かりやすい文書にするためには、いきなり文章を書くのではなく「表現の構成」を考える必要があります。 「表
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
【Mac】無料だけどヤバイ！Wordファイルの作成・編集もできる「Word Processor Pro」が超便利！ - iTea3.0
MySQLのテーブル定義をHTMLに変換して出力するツール · DQNEO日記
