業務での利用事例
業務での利用事例¶ 対象 ソフトウェア開発プロジェクト 規模:1名~10名前後 ドキュメント、書いていますか？¶ 想像してみてください。 この規模、たとえば1名のプロジェクトだとしたらどれくらいドキュメントを書くでしょうか？あるいは10名だったとしたら、どんな役割分担でドキュメントを書くでしょう。 そもそも、彼らはいつドキュメントを書くでしょうか。プロジェクトの方針がある場合、無い場合、色々なケースがあると思いますが、ドキュメントを作る事に対してかれらはどんなことを考えるでしょう。 ドキュメントを書いている割合¶ 業務のプロジェクトには大規模なものから小規模なものまでたくさんありますが、その数に対する「ドキュメントを書いている」比率は意外と低いのではないかと思います。前任者や別の部署・会社から引き継いだプロジェクトにまともなドキュメントがほとんどなかった経験がある方もいるのではないでしょう
Markdown+Pandoc+Gruntでリアルタイムプレビュー＆オリジナルデザインのHTMLドキュメントを生成する - Qiita
Githubなどの普及によりWebサービス上のドキュメントをMarkdown形式で書くことが多くなりました。 そのため、Markdownのプレビュー表示を行うツールやWebサービスなども多く登場してきました。 一方、プレビュー表示以外にも以下のような要望、欲求があると思います。 Webサービスに紐付かないドキュメントとして出力したい デザインを自由に変更したい 顧客やユーザに提供する操作マニュアルやAPI仕様書をMarkdownで作成したいというケースです。 プレビュー表示レベルのものばかりで意外と欲求を満たすものがないのが現状です。 もしかしたら、あるかもしれませんが、今回は自分で小回りの効く環境を作ってみたいと思います。 プレビュー表示のみでよいのであれば、本記事は読み飛ばしてください。 事前準備 事前に以下のモジュールを利用できるようにしておいてください。 Pandoc Node.j
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
